Getting Started

This documentation is for developers who want to use the Digital Engagement APIs to send and get information about their messages, subscribers, owners. It is essential that you’re familiar with web programming concepts and web data formats. The Digital Engagement APIs are HTTP-based RESTful APIs that use JSON Web Tokens for authorization. API request and response bodies are formatted in JSON.

API Platform uses these model classes to expose and document a web API having a bunch of built-in features:

  • Creating, retrieving, updating and deleting (CRUD) resources.

  • Data validation

  • Pagination

  • Filtering

  • Authentication (Basic HTTP)

  • Nice UI and machine- readable documentations (Swagger UI / OpenAPI)

Before you get started you need to ensure that you have completed the following steps:

  1. Get user credentials: You must contact your account manager or support team to obtain user credentials. Once the email is sent, the support team will send you the access credentials (username : your email address and password.)

  2. ​​Get your API Key​​ your account manager will provide the API Key

  3. Make sure you have cURL installed on your machine.



On Windows, use a Bash shell to make cURL calls.