README.md

FeedHenry iBeacon Manager

Management API for iBeacons within the platform.

Group iBeacon Manager API

Retrieve Entry Point

Endpoint	/cloud/beacons
HTTP Method	GET

Response 200 (application/json)

Body

{
    "1234": {
        "major" : 1,
        "minor" : 1,
        "label": "Some Label Title",
        "sublabel": "Some Label Description"
    }
}

Create iBeacon

Create an iBeacon to manage within the platform. Fill in a major and minor ID below to setup your iBeacon

Endpoint	/cloud/beacons
HTTP Method	POST

Request (application/json)

Body

{
  "major" : 1,
  "minor" : 1,
  "label": "Some Label Title",
  "sublabel": "Some Label Description"
}

Response 200 (application/json)

Body

{
  "ok": "true"
}

Tests

All the tests are in the "test/" directory. The cloud app is using mocha as the test runner.

Pre-requisite

• Redis
• MongoDB

Unit tests

npm run serve
npm run unit

Unit coverage

npm run serve
npm run coverage-unit

Accept unit tests

npm run serve  
npm run accept