Service API [v5.0.0]

For versions:5.0.0

Click ‘Download’ button to show summary or download as PDF for offline viewing.

Service API

Service API is an API from 3Dolphins SRM Omnichannel which can be used for integration needs with other systems.

Login as Supervisor’ or ‘Administrator’, for the 3Dolphins SRM login mechanism, do the steps described on the ‘Login‘ page.

Go to API menu and click the Service API menus, then you will see a service API page such as images below.

Field/Notes Description
Method Method indicates the allowed interactions (such as GET, POST, PUT or DELETE) with the resource.
Media Type Specifies the format of the data as type/subtype application/json.
URL This field supports user attributes, they will be URL-encoded with your request.
Body The Body of the 3Dolphins API represents the body of the response/request.
Status HTTP response status codes indicate whether a specific HTTP request has been successfully completed. Responses are grouped in five classes :
1. Informational responses (100199),
2. Successful responses (200299),
3. Redirects (300399),
4. Client errors (400499),
5. Server errors (500599).
ResponseThe Response interface of the 3Dolphins API represents the response to a request.
Server Application Url
Username Username credential
Password Password credential
GeneratedToken Generated token id
Was this article helpful?
Dislike 0