Guides

Getting Started

Suggest Edits

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 documentation (Swagger UI / OpenAPI)

Only a user with administrator permissions on the platform can retrieve the corresponding API Key. The administrator must locate the API Key within the Digital Engagement Platform in the Preferences section, and securely provide it to the development team responsible for the integrations.


Updated 16 days ago