Getting Started
The API uses standard verbs and returns HTTP response codes and JSON-encoded responses.
To get started with the 99 Digital Online REST API, first get the user API key obtained by visiting the profile page. The user API key provides access to endpoints based on the user permissions levels.
Base URL
The base URL for all API endpoints is: https://online.99digital.co.il/api
or to your own api endpoint domain
Authentication
This API requires authentication. All requests must include an Authorization header with a valid API key.
Authorization: Bearer
Path Parameters
For most REST API calls, you must include one or more path parameters on the request URI.
Parameter | Type | Description |
account_id | integer | The numeric ID of the account |
inbox_id | integer | The numeric ID of the inbox |
agent_id | integer | The numeric ID of the agent |
team_id | integer | The numeric ID of the team |
conversation_id | integer | The numeric ID of the conversation |
message_id | integer | The numeric ID of the message |
contact_id | integer | The numeric ID of the contact |
Query Parameters
Some of the REST API calls you can include one or more query parameters on the request URI to filter, limit the size of, and sort the data in an API response. For filter parameters, see the individual GET calls. use these, or similar, query parameters:
🛈 Note: Not all pagination parameters are available for all endpoints. |
Parameter | Type | Description |
sort | string | The attribute by which list should be sorted |
page | integer | The page parameter |