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

Get packages

Request

Returns a list of sellable packages

Security
BasicAuthCredentials
curl -i -X GET \
  -u <username>:<password> \
  https://sandbox.sunlync.net:9000/slapi/packages/packagelist

Responses

Returns a list of sellable packages

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

Get store list

Request

Returns a list stores

Security
BasicAuthCredentials
curl -i -X GET \
  -u <username>:<password> \
  https://sandbox.sunlync.net:9000/slapi/stores/storelist

Responses

Returns a list stores

Bodyapplicaiton/json
storesArray of objects(storeInfo)
Response
applicaiton/json
{
  "stores": [
    { … }
  ]
}

Get eft memberships

Request

Returns a list of sellable EFT memberships

Security
BasicAuthCredentials
curl -i -X GET \
  -u <username>:<password> \
  https://sandbox.sunlync.net:9000/slapi/memberships/eft

Responses

Returns a list of sellable EFT memberships

Bodyapplicaiton/json
membershipsArray of objects(eftMembershipInfo)
Response
applicaiton/json
{
  "memberships": [
    { … }
  ]
}

Get non-eft memberships

Request

Returns a list of sellable NON-EFT memberships

Security
BasicAuthCredentials
curl -i -X GET \
  -u <username>:<password> \
  https://sandbox.sunlync.net:9000/slapi/memberships/noneft

Responses

Returns a list of sellable NON-EFT memberships

Bodyapplicaiton/json
membershipsArray of objects(nonEftMembershipInfo)
Response
applicaiton/json
{
  "memberships": [
    { … }
  ]
}

Get eft deduct types

Request

Returns a list EFT deduction types

Security
BasicAuthCredentials
curl -i -X GET \
  -u <username>:<password> \
  https://sandbox.sunlync.net:9000/slapi/memberships/eftdeducttypes

Responses

Returns a list stores

Bodyapplicaiton/json
typesArray of objects(eftDeductTypes)
Response
applicaiton/json
{
  "types": [
    { … }
  ]
}

Get eft draw days

Request

Returns a list of EFT draw days

Security
BasicAuthCredentials
curl -i -X GET \
  -u <username>:<password> \
  https://sandbox.sunlync.net:9000/slapi/memberships/eftdrawdays

Responses

Returns a list of eft draw days

Bodyapplicaiton/json
typesArray of objects(eftDrawDays)
Response
applicaiton/json
{
  "types": [
    { … }
  ]
}

Get skin types

Request

Returns a list of configured skin types

Security
BasicAuthCredentials
curl -i -X GET \
  -u <username>:<password> \
  https://sandbox.sunlync.net:9000/slapi/setup/skintypes

Responses

Returns a list of configured skin types

Bodyapplicaiton/json
typesArray of objects(skintypes)
Response
applicaiton/json
{
  "types": [
    { … }
  ]
}

Get web documents

Request

Returns a list web documents

Security
BasicAuthCredentials
curl -i -X GET \
  -u <username>:<password> \
  https://sandbox.sunlync.net:9000/slapi/setup/webdocs

Responses

Returns a list web documents

Bodyapplicaiton/json
webdocsArray of objects(webdoc)
Response
applicaiton/json
{
  "webdocs": [
    { … }
  ]
}

Get payment types

Request

Returns a list of payment types by given storecode

Security
BasicAuthCredentials
Query
storecodestring= 10 charactersrequired
Examples:
storecode=0000000001
curl -i -X GET \
  -u <username>:<password> \
  'https://sandbox.sunlync.net:9000/slapi/setup/paymenttypes?storecode=stringstri'

Responses

Get payment types

Bodyapplicaiton/json
paymentTypesArray of objects(paymentType)
Response
applicaiton/json
{
  "paymentTypes": [
    { … }
  ]
}

Get employees

Request

Returns a list of active employees by given storecode

Security
BasicAuthCredentials
Query
storecodestring= 10 charactersrequired
Examples:
storecode=0000000001
curl -i -X GET \
  -u <username>:<password> \
  'https://sandbox.sunlync.net:9000/slapi/setup/employees?storecode=stringstri'

Responses

Get employees

Bodyapplicaiton/json
employeesArray of objects(employee)
Response
applicaiton/json
{
  "employees": [
    { … }
  ]
}

Get products

Request

Returns a list of products by given storecode

Security
BasicAuthCredentials
Query
storecodestring= 10 charactersrequired
Examples:
storecode=0000000001
curl -i -X GET \
  -u <username>:<password> \
  'https://sandbox.sunlync.net:9000/slapi/setup/getproducts?storecode=stringstri'

Responses

Get products

Bodyapplicaiton/json
productsArray of objects(products)
Response
applicaiton/json
{
  "products": [
    { … }
  ]
}

Get slimcd credentials

Request

Returns slimcd credentials by given storecode

  • type = POS - POS Credentials
  • type = EFT - EFT Credentials
Security
BasicAuthCredentials
Query
storecodestring= 10 charactersrequired
Examples:
storecode=0000000001
typestring= 3 charactersrequired
Examples:
type=POS
curl -i -X GET \
  -u <username>:<password> \
  'https://sandbox.sunlync.net:9000/slapi/setup/getslimcdcredentials?storecode=stringstri&type=str'

Responses

Get slimcd credentials

Bodyapplicaiton/json
productsArray of objects(slimcdcredentials)
Response
applicaiton/json
{
  "products": [
    { … }
  ]
}

Get spa profile questions

Request

Returns a list of profile questions

Security
BasicAuthCredentials
curl -i -X GET \
  -u <username>:<password> \
  https://sandbox.sunlync.net:9000/slapi/setup/profilequestions

Responses

Returns a list of profile questions

Bodyapplicaiton/json
questionsArray of objects(profileQuestion)
Response
applicaiton/json
{
  "questions": [
    { … }
  ]
}

User

User related endpoints

Operations