Skip to content

SunLync API (V2) API Definition (0.0.1)

Open API Specificaitons for SunLync API V2

Download OpenAPI description
openapi.json
openapi.yaml
Overview
API Support
support@sunlync.com
License
Languages
Servers
Sandbox server
https://sandbox.sunlync.net:9000/

Client

Client related endpoints

Operations

Configuration

SunLync configuration related endpoints

Operations

User

User related endpoints

Operations

Register user

Request

Registers a user and insert a client, returns client number and user

Security
BasicAuthCredentials
Bodyapplication/json
firstNamestring
Example: "John"
lastNamestring
Example: "Doe"
middleInitstring
Example: "D"
address1string
Example: "1 Main St"
address2string
Example: "Suite 10"
citystring
Example: "Buffalo"
statestring
Example: "NY"
zipstring
Example: "14220"
homePhonestring
Example: "7165551245"
workPhonestring
Example: "7165555678"
cellPhonestring
Example: "7165550987"
emailstring
Example: "test@test.com"
dobstring(date)
Example: "1980-12-25"
storecodestring
Example: "0000000001"
empNostring
Example: "0000000001"
genderstring
Example: "male"
doNotSolicitinteger
Example: 0
emailCommPrefinteger
Example: 1
cellVoiceCommPrefinteger
Example: 1
cellTextCommPrefinteger
Example: 1
homePhoneCommPrefinteger
Example: 1
mailCommPrefinteger
Example: 1
workPhoneCommPrefinteger
Example: 1
passwordstring
Example: "Password123"
curl -i -X POST \
  -u <username>:<password> \
  https://sandbox.sunlync.net:9000/slapi/users/register \
  -H 'Content-Type: application/json' \
  -d '{
    "firstName": "John",
    "lastName": "Doe",
    "middleInit": "D",
    "address1": "1 Main St",
    "address2": "Suite 10",
    "city": "Buffalo",
    "state": "NY",
    "zip": "14220",
    "homePhone": "7165551245",
    "workPhone": "7165555678",
    "cellPhone": "7165550987",
    "email": "test@test.com",
    "dob": "1980-12-25",
    "storecode": "0000000001",
    "empNo": "0000000001",
    "gender": "male",
    "doNotSolicit": 0,
    "emailCommPref": 1,
    "cellVoiceCommPref": 1,
    "cellTextCommPref": 1,
    "homePhoneCommPref": 1,
    "mailCommPref": 1,
    "workPhoneCommPref": 1,
    "password": "Password123"
  }'

Responses

Register User

Bodyapplicaiton/json
clientNumberstring
Example: "0000000001"
messagestring
Example: ""
userIdinteger
Example: 1
Response
applicaiton/json
{
  "clientNumber": "0000000001",
  "message": "",
  "userId": 1
}

Reset password

Request

Resets a user password

Security
BasicAuthCredentials
Bodyapplication/json
emailstring
Example: "test@test.com"
passwordstring
Example: "Password123"
curl -i -X POST \
  -u <username>:<password> \
  https://sandbox.sunlync.net:9000/slapi/users/resetpassword \
  -H 'Content-Type: application/json' \
  -d '{
    "email": "test@test.com",
    "password": "Password123"
  }'

Responses

Reset Password

Bodyapplicaiton/json
clientNumberstring
Example: "0000000001"
messagestring
Example: ""
userIdinteger
Example: 1
Response
applicaiton/json
{
  "clientNumber": "0000000001",
  "message": "",
  "userId": 1
}

Login

Request

Validates a login and logs that the user has logged in

Security
BasicAuthCredentials
Bodyapplication/json
emailstring
Example: "test@test.com"
passwordstring
Example: "Password123"
curl -i -X POST \
  -u <username>:<password> \
  https://sandbox.sunlync.net:9000/slapi/users/login \
  -H 'Content-Type: application/json' \
  -d '{
    "email": "test@test.com",
    "password": "Password123"
  }'

Responses

Login

Bodyapplicaiton/json
clientNumberstring
Example: "0000000001"
messagestring
Example: ""
userIdinteger
Example: 1
Response
applicaiton/json
{
  "clientNumber": "0000000001",
  "message": "",
  "userId": 1
}