REST API Architecture

Representational State Transfer (REST) APIs are widely used as a way to provide easy access to resources for developers regardless of the programming language used in development. Developers can use Symphony's REST APIs to create tools and applications for sending and receiving messages, user administration, and chat management.

REST API endpoints are implemented on several physical interfaces:

  • The Pod is a cloud-based Symphony server infrastructure deployed in the cloud.
  • The Key Manager holds encryption key material for Symphony users.
  • The Agent provides encryption and decryption services for applications calling the Agent API.

📘

Permissions

Some endpoints require the user to have certain roles in order to be executed. See Permissions for a complete list.

For security reasons, both the Key Manager and the Agent are typically deployed onsite at the customer's location; however, in some cases (for example, in testing environments) they may be deployed in the cloud.

Updated about a year ago



REST API Architecture


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.