Public API – GET Beacons

The GET Beacons endpoint returns a list of Beacons with their details or the details of a particular Beacon from a customer account. The examples below describe the use of the endpoint and the keys it expects.

URL to call

https://api.bluedotinnovation.com/1/beacons

Parameters

Name
Required
Data Type
Description
Format
customerApiKey String API key for customer (rather than the app).
beaconId String The identifier for the Beacon to be retrieved.
pageNumber Number A specific page number for a paginated result set; each page has 100 results.  0 – N

GET all Beacons

Using only the Customer API Key to retrieve Beacon details will return a list of Beacons as a JSON array for a given customer.

https://api.bluedotinnovation.com/1/beacons?customerApiKey=1a64a14c-5bc8-44bb-ab9a-076c4518b407

https://api.bluedotinnovation.com/1/beacons?customerApiKey=4eb1598f-e3d8-4a59-bb79-4a29faddd8ab&pageNumber=2

Example: JSON response for GET all Beacons

[
    {
        "beaconId": "db4c24bd-6403-4bad-ac86-6a25086c5a0e",
        "name": "180 Sansome St, San Francisco, CA 94104",
        "longitude": -122.4006339,
        "latitude": 37.7919951,
        "type": "Both",
        "txPower": -65,
        "macAddress": "B4:99:4C:8D:08:B0",
        "major": 1,
        "minor": 18,
        "proximityUUID": "e2c56db5-dffb-48d2-b060-d0f5a71096e0",
        "description": "Sanfrancisco office front door"
    },
    {
        "beaconId": "91b57ffe-2661-4571-871a-10d65902a0bf",
        "name": "200 Pine St, San Francisco, CA 94104",
        "longitude": -122.400701,
        "latitude": 37.7923722,
        "type": "Android",
        "txPower": -80,
        "macAddress": "F4:99:4C:8D:08:A1",
        "description": "Cupcake Shop"
    },
    {
        "beaconId": "71a6cc46-3646-496a-8fbd-40923f3397eb",
        "name": "22 Battery St, San Francisco, CA 94104",
        "longitude": -122.4006043,
        "latitude": 37.7920203,
        "type": "IOS",
        "major": 4568,
        "minor": 5214,
        "proximityUUID": "c335f0e2-62b7-46df-a173-b4a8d7c70c65",
        "description": "Coffee Shop"
    }
]

GET a specific Beacon

Using the Customer API Key & the Beacon ID of a Beacon to retrieve Beacon details, will return Beacon configuration details added in Bluedot backend as a JSON object.
https://api.bluedotinnovation.com/1/beacons?customerApiKey=1a64a14c-5bc8-44bb-ab9a-076c4518b407&beaconId=db4c24bd-6403-4bad-ac86-6a25086c5a0e

Example: JSON response for GET specific Beacon

{
    "beaconId": "db4c24bd-6403-4bad-ac86-6a25086c5a0e",
    "name": "180 Sansome St, San Francisco, CA 94104",
    "longitude": 144.979512,
    "latitude": -37.818027,
    "type": "Both",
    "txPower": -65,
    "macAddress": "B4:99:4C:8D:08:B0",
    "major": 1,
    "minor": 18,
    "proximityUUID": "e2c56db5-dffb-48d2-b060-d0f5a71096e0",
    "description": "Sanfrancisco office front door"
}

Source code examples

Created by Bluedot DevOps on March 3, 2018

Start the discussion