Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Introduction

This document details how 3rd Party web services should be making API calls to Bluzone.  To get started, you need to locate your projectId and your APIKey.  Each user has a unique API Key for their account and team.  For each team that a user is a member (or owner), there is a unique API Key.  The API Key 

Locating ProjectId and ApiKey

Login to Bluzone and click on your username in the top right corner of the screen

The account details page lists all projects with projectId and apiKey

The REST API Call

REST API calls to Bluzone with the APIKey usually need the projectId in the URL.  They also need the APIKey in the HTTP Request Header.  The header name is "bzid" and the header value is the API Key.

Example Requests

Get Project Details

curl -X GET \
  https://bluzone.io/portal/papis/v1/projects/<YOUR_PROJECT_ID_HERE>/ \
  -H 'bzid: <YOUR_API_KEY_HERE>'

Get List of Beacons

curl -X GET \
  https://bluzone.io/portal/papis/v1/projects/<YOUR_PROJECT_ID_HERE>/devices/beacons \
  -H 'bzid: <YOUR_API_KEY_HERE>'

Get A Single Beacon

curl -X GET \
  https://bluzone.io/portal/papis/v1/projects/<YOUR_PROJECT_ID_HERE>/devices/beacons/<BEACON_ID_HERE> \
  -H 'bzid: <YOUR_API_KEY_HERE>'



  • No labels