Docs
Integrations

Developer API

What is the API?

The REST API is an interface that allows developers and system administrators to programmatically interact with their infrastructure managed through emma. By using the API, you can create, modify, and delete resources, monitor the status of your infrastructure, and automate repetitive tasks. This can greatly enhance the efficiency of your infrastructure management processes.

API Documentation

emma Infrastructure API Documentation

Getting Started

To start using the API, you will need an API key, which you can obtain from your project.

  1. Enter your project,
  2. Navigate to Settings > Service Apps,
  3. Create a service application. Select the access level Read, Operate, or Manage,
  4. Copy the Client ID and Client Secret in the service application,
  5. Send an API request to the endpoint /issue-token as specified in the Authentication section of the API documentation. You will receive access and refresh tokens in the response.

How to Use the Bearer Access Token

The Bearer access token is a text string, included in the request header, for example:

curl -X GET https://api.emma.ms/external/v1/locations -H "Authorization: Bearer YOUR_ACCESS_TOKEN_HERE"

Once you have the token, include it in the header of your API requests to authenticate and interact with the system.

How is this guide?

Last updated on 10 Sept 2024

On this page