myPresences API – mypresences

The myPresences API allows you to connect myPresences to other applications or use the information in myPresences in other ways.

The API is available at:

https://app.mypresences.com/api/v2/

Documentation

Documentation is available in either Swagger or Redoc formats:

Swagger

https://app.mypresences.com/swagger/

Swagger is an online interface to the API where you can test API calls.

Use the Authorise button and enter your API Key. Once authorised you will be able to call the API endpoints successfully.

Redoc

https://app.mypresences.com/redoc/

If you prefer a Redoc interface that is also available.

API Keys

API Keys are currently provided on request to accounts that have Pro Access.

To get an API Key please contact support.

Authorization

Not all API endpoints support API Key authorization.

However, the API's you should need access to are accessible. If you require access to an API endpoint that is not currently enabled for API please let us know.

To authenticate access to the API you should pass your API Key in the header of all calls to the API.

Use the X-API-Key header set to the value of your API Key.

X-API-Key: <api_key>

Your API key is linked to your account and will provide access to all businesses and users under your account. If you have sub-accounts you will also have access to businesses and users in your sub-accounts.

Developer Tab

If you have an API Key enabled on your account a new Tab will appear in your Account Page.

This page will show your have an API Key and give you the first few characters to know which one it is.

Once generated we do not retain the full API Key. If you lose the key please request a new one.

Web-hooks

The developer tab also includes your webhook setup which allows external services to be notified when things change in your myPresences account.

Add the Url you would like to be called whenever an event occurs. This Url should return a 200 response on success.

If you would also like web-hooks to be sent for changes to businesses in sub-accounts enable the Include SubAccounts option.

Currently the only supported event is new reviews. Enable Reviews to turn on Review webhooks. More event types will be added in the future. Please let us know if there are other events you would like to be notified of via web-hook.

Use Cases

You can use the API for a number of purposes, some of the most common are:

Listing business locations under your account
Adding new businesses to your account
Accessing listings for a particular business location
Accessing reviews for a particular business location

If there is a use case you would like the API to support that is not covered in the documentation please contact support.