{"_id":"55650b9fb893840d00444704","createdAt":"2015-05-27T00:11:11.861Z","hidden":false,"__v":9,"api":{"auth":"required","params":[],"results":{"codes":[]},"settings":"","url":""},"sync_unique":"","title":"Getting Started","category":"55650b9fb893840d00444702","githubsync":"","isReference":false,"order":0,"parentDoc":null,"slug":"getting-started","type":"basic","updates":[],"body":"[block:api-header]\n{\n \"type\": \"basic\",\n \"title\": \"Base URI: http(s)://meshblu-http.octoblu.com\"\n}\n[/block]\n\n[block:callout]\n{\n \"type\": \"info\",\n \"title\": \"Web Browser Bundle\",\n \"body\": \"You may include meshblu-http in your webbrowser by using the following link:\\n\\n[https://cdn.octoblu.com/js/meshblu-http/latest/meshblu-http.bundle.js](https://cdn.octoblu.com/js/meshblu-http/latest/meshblu-http.bundle.js)\"\n}\n[/block]\n\n[block:callout]\n{\n \"type\": \"danger\",\n \"body\": \"Most of our API endpoints require authentication credentials (UUID and secret token) passed in the HTTP headers as meshblu_auth_uuid and meshblu_auth_token respectively.\",\n \"title\": \"Authentication\"\n}\n[/block]\n\n[block:callout]\n{\n \"type\": \"warning\",\n \"title\": \"Content-Type\",\n \"body\": \"If you are posting JSON in the body, you must set the Content-Type: application/json\"\n}\n[/block]\nThese credentials are generated by registering a device or user with Meshblu via the [POST /Devices](/v1.0/docs/devices#devices) API (see below). If you would like to associate additional Meshblu devices to the UUID and Token that you created (as a user), you can add an \"owner\" property to your other devices with the user's UUID as its value.\n\nWe support the following device permissions: View/Discover, Send Messages, and Configure. These permissions are manageable by adding UUIDs to whitelists and blacklists arrays with the following names: viewWhitelist, viewBlacklist, sendWhitelist, sendBlacklist, updateWhitelist, updateBlacklist. Note: If your UUID is the same as the \"owner\" UUID, these permissions are not enforced (you are the owner).","excerpt":"This page will help you get started with Meshblu HTTP. You'll be up and running in a jiffy!","link_external":false,"link_url":"","project":"55650b9eb893840d004446fe","user":"5564f227f0f70f0d00a9ab20","version":"55650b9eb893840d00444701","childrenPages":[]}

Documentation

Getting Started

This page will help you get started with Meshblu HTTP. You'll be up and running in a jiffy!

[block:api-header]
{
"type": "basic",
"title": "Base URI: http(s)://meshblu-http.octoblu.com"
}
[/block]
[block:callout]
{
"type": "info",
"title": "Web Browser Bundle",
"body": "You may include meshblu-http in your webbrowser by using the following link:\n\n[https://cdn.octoblu.com/js/meshblu-http/latest/meshblu-http.bundle.js](https://cdn.octoblu.com/js/meshblu-http/latest/meshblu-http.bundle.js)"
}
[/block]
[block:callout]
{
"type": "danger",
"body": "Most of our API endpoints require authentication credentials (UUID and secret token) passed in the HTTP headers as meshblu_auth_uuid and meshblu_auth_token respectively.",
"title": "Authentication"
}
[/block]
[block:callout]
{
"type": "warning",
"title": "Content-Type",
"body": "If you are posting JSON in the body, you must set the Content-Type: application/json"
}
[/block]
These credentials are generated by registering a device or user with Meshblu via the [POST /Devices](/v1.0/docs/devices#devices) API (see below). If you would like to associate additional Meshblu devices to the UUID and Token that you created (as a user), you can add an "owner" property to your other devices with the user's UUID as its value.
We support the following device permissions: View/Discover, Send Messages, and Configure. These permissions are manageable by adding UUIDs to whitelists and blacklists arrays with the following names: viewWhitelist, viewBlacklist, sendWhitelist, sendBlacklist, updateWhitelist, updateBlacklist. Note: If your UUID is the same as the "owner" UUID, these permissions are not enforced (you are the owner).