How Do I Use the EasySignage API?

Learn how to create an EasySignage API key, choose what it can access, and authenticate requests so your own systems can update your screens.

How do I get started with the API?

Create an API key in Settings > API Keys, grant it access to the areas it needs, and send it in an X-API-Key header. A key acts on one account with exactly the access you give it, and you can delete it at any time.

API access is included with the Premium plan. Sign in to the account the key should act on before you create it, because a key is bound to the account you are managing at the time.

 

How do I create an API key?

  • Go to Settings > API Keys
  • Select Create API Key
  • Enter a Name that says what the key is for, usually the system that will use it
  • Set each area to No access, Read only, or Full access
  • Select Create API Key
  • Copy the key

The key is shown once and cannot be retrieved later. Copy it before you close the dialog. If you lose it, delete the key and create a new one.

 

What can a key be given access to?

Permissions are set area by area: Screens, Groups, Video Wall, Playlists, Channels, Zones, Sync groups, Schedules, Folders, and Media Assets. Each one is No access, Read only, or Full access.

You must grant at least one area, and it is worth granting only what the calling system genuinely needs. A key that only reads screen status has no business editing playlists.

 

How do I authenticate a request?

Send the key in an X-API-Key header:

X-API-Key: ds_api_...

The key resolves both the brand and the account by itself, so X-Account and X-Domain headers are ignored on an API key request. A key cannot be pointed at a different account.

 

Where is the API documentation?

  • Go to Settings > API Keys
  • Select Open API Docs

The documentation opens in a new tab and signs you in automatically. It has no separate login, so open it from Settings > API Keys rather than bookmarking the page.

 

How do I rotate or revoke a key?

There is no rotate action. Create the replacement key first, move your systems onto it, then delete the old one, so nothing stops working during the switch.

To revoke a key, select the delete icon on it and confirm. Deletion takes effect immediately, cannot be undone, and anything using that key fails on its next request. The key’s details stay in your account log.

An account can hold up to 10 API keys.

 

Why am I getting a 403?

A failed API key request answers 403 with an empty body, and every cause looks identical on purpose so the API cannot be used to discover which keys exist. An unknown key, an altered key, a deleted key, a permission that was never granted, and an account without API access all return the same response.

Check that the key is still listed under Settings > API Keys, that the area you are calling is granted, and that the account still has API access.