Skip to content

SunLync API (V2) API Definition (0.0.1)

Open API Specificaitons for SunLync API V2

Download OpenAPI description
Overview
API Support
License
Languages
Servers
Sandbox server
https://sandbox.sunlync.net:9000/

Client

Client related endpoints

Operations

Freeze membership

Request

Freezes an active eft membership

Security
BasicAuthCredentials
Bodyapplication/json
clientNumberstring
Example: "0000000001"
membershipIdstring
Example: "0000000001"
nextDuesAmountnumber(float)
Example: 5
freezeDatestring(date)
Example: "2025-08-01"
freezeMonthsinteger
Example: 12
curl -i -X POST \
  -u <username>:<password> \
  https://sandbox.sunlync.net:9000/slapi/clients/freezemembership \
  -H 'Content-Type: application/json' \
  -d '{
    "clientNumber": "0000000001",
    "membershipId": "0000000001",
    "nextDuesAmount": 5,
    "freezeDate": "2025-08-01",
    "freezeMonths": 12
  }'

Responses

Membership updated

Bodyapplicaiton/json
messagestring
Example: ""
membershipIdstring
Example: "0000000001"
Response
applicaiton/json
{ "message": "", "membershipId": "0000000001" }

Unfreeze membership

Request

Unfreezes a frozen eft membership

Security
BasicAuthCredentials
Bodyapplication/json
clientNumberstring
Example: "0000000001"
membershipIdstring
Example: "0000000001"
incAffiliatedPackageinteger
Example: 1
curl -i -X POST \
  -u <username>:<password> \
  https://sandbox.sunlync.net:9000/slapi/clients/unfreezemembership \
  -H 'Content-Type: application/json' \
  -d '{
    "clientNumber": "0000000001",
    "membershipId": "0000000001",
    "incAffiliatedPackage": 1
  }'

Responses

Membership updated

Bodyapplicaiton/json
messagestring
Example: ""
membershipIdstring
Example: "0000000001"
Response
applicaiton/json
{ "message": "", "membershipId": "0000000001" }

Activate membership

Request

Activate a membership that is on hold

Security
BasicAuthCredentials
Bodyapplication/json
clientNumberstring
Example: "0000000001"
membershipIdstring
Example: "0000000001"
curl -i -X POST \
  -u <username>:<password> \
  https://sandbox.sunlync.net:9000/slapi/clients/activatemembership \
  -H 'Content-Type: application/json' \
  -d '{
    "clientNumber": "0000000001",
    "membershipId": "0000000001"
  }'

Responses

Membership activated successfully

Bodyapplicaiton/json
messagestring
Example: ""
membershipIdstring
Example: "0000000001"
Response
applicaiton/json
{ "message": "", "membershipId": "0000000001" }

Configuration

SunLync configuration related endpoints

Operations

User

User related endpoints

Operations