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
http://sandbox.sunlync.net:9000
Operations

Request

Returns a list trasnsactions for a given client number

Security
BasicAuthCredentials
Query
clientnumberstring= 10 charactersrequired
Examples:
clientnumber=0000000046
startdatestring(date)required
Examples:
startdate=2025-01-01
enddatestring(date)required
Examples:
enddate=2025-01-01
includedetailintegerrequired
Examples:
includedetail=1
trantypesstring
Examples:
trantypes=T,R,M,P
curl -i -X GET \
  -u <username>:<password> \
  'http://sandbox.sunlync.net:9000/slapi/clients/transactionhistory?clientnumber=stringstri&startdate=2019-08-24&enddate=2019-08-24&includedetail=0&trantypes=string'

Responses

Get a list of tranactions

Bodyapplicaiton/json
transactionsArray of objects(transactions)
Response
applicaiton/json
{ "transactions": [ {} ] }

Request

Returns a list of clients sharing an affiliated package by given membership id

Security
BasicAuthCredentials
Query
membershipidstring= 10 charactersrequired
Examples:
membershipid=0000000001
curl -i -X GET \
  -u <username>:<password> \
  'http://sandbox.sunlync.net:9000/slapi/setup/affiliatedpackageclients?membershipid=stringstri'

Responses

Get affilicated package clients

Bodyapplicaiton/json
clientsArray of objects(affiliatedpackageclients)
Response
applicaiton/json
{ "clients": [ {} ] }

Request

Returns a list of packages shared with a client by a given client number

Security
BasicAuthCredentials
Query
clientnumberstring= 10 charactersrequired
Examples:
clientnumber=0000000001
curl -i -X GET \
  -u <username>:<password> \
  'http://sandbox.sunlync.net:9000/slapi/clients/getsharedpackages?clientnumber=stringstri'

Responses

Get shared packages

Bodyapplicaiton/json
packagesArray of objects(sharedpackages)
Response
applicaiton/json
{ "packages": [ {} ] }

Configuration

SunLync configuration related endpoints

Operations
Operations