ESPER API REFERENCE (1.0.0)

Download OpenAPI specification:Download

Introduction

To quickly get started with our APIs, see the API Reference guide. To learn more about APIs and how to use them, head over to our Getting Started with APIs guide.

With these APIs, you can orchestrate and manage devices that have been provisioned against your Esper Console environment. Furthermore, these APIs allow you to manage the Android applications installed on your Dedicated Device fleet.

To read more about the various capabilities of Esper APIs and Esper managed devices, please visit esper.io.

This guide describes all the available APIs in detail, along with code samples for you to quickly ramp up to using them. We've done our best to keep this document up to date, but please reach out to us at developer@esper.io if you have any concerns.

SDK

You are welcome to use your favorite HTTP/REST library for your programming language in order to call these APIs, or you can use our SDK (currently supporting python) to do so.

Authentication

You need to create an API Key to interact with the Esper APIs. Learn more about generating an API Key. You can find out more about Esper and sign up for a free account at esper.io/signup.

Errors

The APIs use standard HTTP status codes to indicate success or failure. All error responses will have a JSON body in the following format:

{
  "errors": [],
  "message": "error message",
  "status": 400
}
  • errors - List of error details
  • message - Error description
  • status - HTTP status code