Overview

Overview of the Manage API.

The Beaconinside MANAGE API allows you to programmatically access all your Accounts, Applications, Beacons and Groups in the Beaconinside CMS.

This API is organized by resource type which has a data representation and one or more methods.

The key resource types are:

To access the above resources one must log in using the Authentication resource and obtain a session token. This token must be sent as header parameter in all further requests.

Authentication

Method
Request
Description

POST
"/manager/v1/auth/login"

Endpoint to log into an already registered account.

DELETE
"/manager/v1/auth/logout"

Endpoint for invalidating a session token.

Accounts

For the Accounts resource we have the following endpoints:

Method
Request
Desription

GET
"/manager/v1/accounts/:accountId"

Get's the account's metadata by Id.

PUT
"/manager/v1/accounts/:accountId"

Patches the account entity with values from body.

DELETE
"/manager/v1/accounts/:accountId"

Deletes the account identified by it's ID.

GET
"/manager/v1/accounts/:accountId/applications"

Gets the list of applications for the account.

GET
"/manager/v1/accounts/:accountId/beacons"

Gets a list of beacons for the account.

GET
"/manager/v1/accounts/:accountId/groups"

Gets a list of groups for the account.

Beacons

For the Beacons resource we have the following endpoints:

Method
Request
Description

POST
"/manager/v1/beacons"

Creates a new beacon entity.

GET
"/manager/v1/beacons/:beaconId"

Gets a beacon entity by Id.

PUT
"/manager/v1/beacons/:beaconId"

Updates a beacon entity with values from the request's body.

PATCH
"/manager/v1/beacons/:beaconId?fields=name"

Patches a beacon entity with values from the request's body.

DELETE
"/manager/v1/beacons/:beaconId"

Deletes a beacon by Id.

GET
"/manager/v1/beacons/:beaconId/groups"

Get's a list of groups this beacon belongs to, by Id.

GROUPS

For the Groups resource we have the following endpoints:

Method
Request
Description

POST
"/manager/v1/groups"

Creates a new group entity.

GET
"/manager/v1/groups/:groupId"

Get's group entity by Id.

PATCH
"/manager/v1/groups/:groupId?fields"

Patches group entity with values from body.

DELETE
"/manager/v1/groups/:groupId"

Deletes a group by Id.

GET
"/manager/v1/groups/:groupId/beacons"

Get's the list of beacons belonging to this group, by Id.

Overview

Overview of the Manage API.