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

Insert spa profile answers

Request

Inserts spa profile answers

Security
BasicAuthCredentials
Bodyapplication/json
clientNumberstring
Example: "0000000001"
answersArray of objects
curl -i -X POST \
  -u <username>:<password> \
  https://sandbox.sunlync.net:9000/slapi/clients/insertprofileanswers \
  -H 'Content-Type: application/json' \
  -d '{
    "clientNumber": "0000000001",
    "answers": [
      {
        "id": 1,
        "answer": "No",
        "choice_answer_1": 0,
        "choice_answer_2": 0,
        "choice_answer_3": 0,
        "choice_answer_4": 0,
        "choice_answer_5": 0
      }
    ]
  }'

Responses

Profile answers inserted

Bodyapplicaiton/json
messagestring
Example: "Profile answers inserted successfully"
Response
applicaiton/json
{ "message": "Profile answers inserted successfully" }

Add a referral

Request

Add a referral

Security
BasicAuthCredentials
Bodyapplication/json
clientNumberstring
Example: "0000000001"
emailstring
Example: "johndoe@testemail.com"
allowMultiplenumber
Example: 1
curl -i -X POST \
  -u <username>:<password> \
  https://sandbox.sunlync.net:9000/slapi/clients/addreferral \
  -H 'Content-Type: application/json' \
  -d '{
    "clientNumber": "0000000001",
    "email": "johndoe@testemail.com",
    "allowMultiple": 1
  }'

Responses

Referral added successfully

Bodyapplicaiton/json
messagestring
Example: ""
Response
applicaiton/json
{ "message": "" }

Generate webdoc URL

Request

Generates a webdoc URL

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

Responses

Webdoc generated

Bodyapplicaiton/json
messagestring
Example: ""
urlstring
Example: "http://127.0.0.1:5002/show_web_doc/eftdoc.html/0/18/0000000070/?sig=67a4024c95b90d869f110ac2bbc6de34"
Response
applicaiton/json
{ "message": "", "url": "http://127.0.0.1:5002/show_web_doc/eftdoc.html/0/18/0000000070/?sig=67a4024c95b90d869f110ac2bbc6de34" }

Configuration

SunLync configuration related endpoints

Operations

User

User related endpoints

Operations