Brain Web API
This document describes the [Intellifi Brain](https://intellifi.zendesk.com/hc/en-us/categories/360000685454) Web API specification using the [OpenAPI…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
This document describes the Intellifi Brain
Web API specification using the OpenAPI specification.
The Brain Web API is a RESTful API that allows you to interact with the
Intellifi devices and
services in a powerful and simple way. Our end-to-end solution allows you to
localize your items/assets based on technologies such as RFID and Bluetooth.
Try it out!
The API can be tried out and tested using the 'api-doc/tryitout' endpoint on this site.
This UI allows anyone to visualize and interact with the API’s resources without having any of the implementation logic in place.
It’s automatically generated from this Specification, with the visual documentation making it easy for back end implementation and client side consumption.
Authentication
Applications are required to provide some form of authentication to the API
for every secured endpoint. The Brain offers two forms of authentication.
- API key (Via an HTTP request header or URL parameter)
- Session cookie
-->
See also
- About Intellifi and what we do: intellifi.nl
- Technical and background information: intellifi.zendesk.com
Endpoints 77
authinfo
- GETAuthentication information
/authinfo
blobs
- GETGet all binary large objects (blob)
/blobs?after=2016-01-27T08:38:55.255Z&after_id=56a88364e783152127d15340&before=2016-01-27T08:38:55.255Z&before_id=56a88364e783152127d15340&from=2016-01-27T08:38:55.255Z&from_id=56a88364e783152127d15340&id_only=false&limit=5&populate=location,item&results_only=false&select=type,location.label&sort=-move_count,technology&until=2016-01-27T08:38:55.255Z&until_id=56a88364e783152127d15340&timeout_s=60&id=5b8d0b717503c445552a1865&time_created=2018-08-30T09:51:59.737Z&time_updated=2018-08-30T09:51:59.737Z&hash=string&blob_key=string&content_type=string&filename=string&time_last_accessed=string - POSTCreate binary large object (blob) metadata
/blobs - GETGet binary large object (blob)
/blobs/:id - DELETEDelete binary large object (blob)
/blobs/:id - GETDownload a binary large object (blob)
/blobs/:id/download/:filename - POSTCreate binary large object (blob)
/blobs/:id/upload
events
- GETGet all events
/events?after=2016-01-27T08:38:55.255Z&after_id=56a88364e783152127d15340&before=2016-01-27T08:38:55.255Z&before_id=56a88364e783152127d15340&from=2016-01-27T08:38:55.255Z&from_id=56a88364e783152127d15340&id_only=false&limit=5&populate=location,item&results_only=false&sort=-move_count,technology&until=2016-01-27T08:38:55.255Z&until_id=56a88364e783152127d15340&timeout_s=60&id=5b8d0b717503c445552a1865&time_created=2018-08-30T09:51:59.737Z&topic.resource_type=items&topic.action=created&topic.resource=5b7d6cbd7503c445552a1664&time_event=2018-08-30T09:51:59.737Z&time_expire=2018-08-30T09:51:59.737Z - GETGet event
/events/:id
items
- GETGet all items
/items?after=2016-01-27T08:38:55.255Z&after_id=56a88364e783152127d15340&after_code=e20000000000000000000000&before=2016-01-27T08:38:55.255Z&before_id=56a88364e783152127d15340&before_code=e20000000000000000001fff&from=2016-01-27T08:38:55.255Z&from_id=56a88364e783152127d15340&from_code=e20000000000000000000000&id_only=false&limit=5&populate=location,item&results_only=false&select=type,location.label&sort=-move_count,technology&until=2016-01-27T08:38:55.255Z&until_id=56a88364e783152127d15340&timeout_s=60&until_code=e20000000000000000001ffff&id=5b8d0b717503c445552a1865&time_created=2018-08-30T09:51:59.737Z&time_updated=2018-08-30T09:51:59.737Z&code_hex=*42*&is_present=true&label=*foo*&location=5b7d6cbd7503c445552a1664&metadata=string&move_count=5342&protocol=epcgen2&sets=5b8d0b717503c445552a1865&technology=rfid&text=penguin&time_last_present=2018-09-03T10:23:46.596Z&time_moved=2018-08-30T09:51:59.737Z&type=tag - POSTCreate item
/items - GETGet item
/items/:id - PUTUpdate existing item
/items/:id - DELETEDelete item
/items/:id
keys
- GETGet all keys
/keys?after=2016-01-27T08:38:55.255Z&after_id=56a88364e783152127d15340&before=2016-01-27T08:38:55.255Z&before_id=56a88364e783152127d15340&from=2016-01-27T08:38:55.255Z&from_id=56a88364e783152127d15340&id_only=false&limit=5&populate=location,item&results_only=false&select=type,location.label&sort=-move_count,technology&until=2016-01-27T08:38:55.255Z&until_id=56a88364e783152127d15340&timeout_s=60&id=5b8d0b717503c445552a1865&time_created=2018-08-30T09:51:59.737Z&time_updated=2018-08-30T09:51:59.737Z&secret=string&label=string&is_read_only=trueCan only be used by an administrative user. - POSTCreate key
/keysCan only be used by an administrative user. - GETGet key
/keys/:idCan only be used by an administrative user. - PUTUpdate existing key
/keys/:idCan only be used by an administrative user. - DELETEDelete key
/keys/:idCan only be used by an administrative user.
kvpairs
- GETGet all key-value pairs
/kvpairs?after=2016-01-27T08:38:55.255Z&after_id=56a88364e783152127d15340&before=2016-01-27T08:38:55.255Z&before_id=56a88364e783152127d15340&from=2016-01-27T08:38:55.255Z&from_id=56a88364e783152127d15340&id_only=false&limit=5&populate=location,item&results_only=false&select=type,location.label&sort=-move_count,technology&until=2016-01-27T08:38:55.255Z&until_id=56a88364e783152127d15340&timeout_s=60&id=5b8d0b717503c445552a1865&time_created=2018-08-30T09:51:59.737Z&time_updated=2018-08-30T09:51:59.737Z&kv_key=string - POSTCreate key-value pair
/kvpairs - GETGet key-value pair
/kvpairs/:id - PUTUpdate existing Key-value pair
/kvpairs/:id - DELETEDelete key-value pair
/kvpairs/:id
locations
- GETGet all locations
/locations?after=2016-01-27T08:38:55.255Z&after_id=56a88364e783152127d15340&before=2016-01-27T08:38:55.255Z&before_id=56a88364e783152127d15340&from=2016-01-27T08:38:55.255Z&from_id=56a88364e783152127d15340&id_only=false&limit=5&populate=location,item&results_only=false&select=type,location.label&sort=-move_count,technology&until=2016-01-27T08:38:55.255Z&until_id=56a88364e783152127d15340&timeout_s=60&id=5b8d0b717503c445552a1865&time_created=2018-08-30T09:51:59.737Z&time_updated=2018-08-30T09:51:59.737Z&label=*foo*&metadata=string&text=penguin - POSTCreate location
/locations - GETGet location
/locations/:id - PUTUpdate existing location
/locations/:id - DELETEDelete location
/locations/:id
locationrules
- GETGet all location rules
/locationrules?after=2016-01-27T08:38:55.255Z&after_id=56a88364e783152127d15340&before=2016-01-27T08:38:55.255Z&before_id=56a88364e783152127d15340&from=2016-01-27T08:38:55.255Z&from_id=56a88364e783152127d15340&id_only=false&limit=5&populate=location,item&results_only=false&select=type,location.label&sort=-move_count,technology&until=2016-01-27T08:38:55.255Z&until_id=56a88364e783152127d15340&timeout_s=60&id=5b8d0b717503c445552a1865&time_created=2018-08-30T09:51:59.737Z&time_updated=2018-08-30T09:51:59.737Z&label=*foo*&type=allow&enabled=true - POSTCreate location rule
/locationrules - GETGet location rule
/locationrules/:id - PUTUpdate existing location rule
/locationrules/:id - DELETEDelete location rule
/locationrules/:id
presences
- GETGet all presences
/presences?after=2016-01-27T08:38:55.255Z&after_id=56a88364e783152127d15340&before=2016-01-27T08:38:55.255Z&before_id=56a88364e783152127d15340&from=2016-01-27T08:38:55.255Z&from_id=56a88364e783152127d15340&id_only=false&limit=5&populate=location,item&results_only=false&select=type,location.label&sort=-move_count,technology&until=2016-01-27T08:38:55.255Z&until_id=56a88364e783152127d15340&timeout_s=60&id=5b8d0b717503c445552a1865&time_created=2018-08-30T09:51:59.737Z&time_updated=2018-08-30T09:51:59.737Z&item=5b7d6cbd7503c445552a1664&location=5b7d6cbd7503c445552a1664&proximity=immediate&technology=rfid - GETGet presence
/presences/:id
services
- GETGet all services
/services?after=2016-01-27T08:38:55.255Z&after_id=56a88364e783152127d15340&before=2016-01-27T08:38:55.255Z&before_id=56a88364e783152127d15340&from=2016-01-27T08:38:55.255Z&from_id=56a88364e783152127d15340&id_only=false&limit=5&populate=location,item&results_only=false&select=type,location.label&sort=-move_count,technology&until=2016-01-27T08:38:55.255Z&until_id=56a88364e783152127d15340&timeout_s=60&id=5b8d0b717503c445552a1865&time_created=2018-08-30T09:51:59.737Z&time_updated=2018-08-30T09:51:59.737Z&name=*foo* - GETGet service
/services/:id - PUTUpdate existing service
/services/:id
sets
- GETGet all item lists
/sets/itemlists?after=2016-01-27T08:38:55.255Z&after_id=56a88364e783152127d15340&before=2016-01-27T08:38:55.255Z&before_id=56a88364e783152127d15340&from=2016-01-27T08:38:55.255Z&from_id=56a88364e783152127d15340&id_only=false&limit=5&populate=location,item&results_only=false&select=type,location.label&sort=-move_count,technology&until=2016-01-27T08:38:55.255Z&until_id=56a88364e783152127d15340&timeout_s=60&id=5b8d0b717503c445552a1865&time_created=2018-08-30T09:51:59.737Z&time_updated=2018-08-30T09:51:59.737Z&label=*foo*&metadata=string&text=penguin&total=2&sha1=92cfceb39d57d914ed8b14d0e37643de0797ae56 - POSTCreate item list
/sets/itemlists - GETGet item list
/sets/itemlists/:id - PUTUpdate existing item list
/sets/itemlists/:id - DELETEDelete item list
/sets/itemlists/:id - GETGet item ids for this list
/sets/itemlists/:id/ids - POSTAdd items to an existing list
/sets/itemlists/:id/ids - DELETEDelete item from list
/sets/itemlists/:id/ids/:itemId - GETGet all spot lists
/sets/spotlists?after=2016-01-27T08:38:55.255Z&after_id=56a88364e783152127d15340&before=2016-01-27T08:38:55.255Z&before_id=56a88364e783152127d15340&from=2016-01-27T08:38:55.255Z&from_id=56a88364e783152127d15340&id_only=false&limit=5&populate=location,item&results_only=false&select=type,location.label&sort=-move_count,technology&until=2016-01-27T08:38:55.255Z&until_id=56a88364e783152127d15340&timeout_s=60&id=5b8d0b717503c445552a1865&time_created=2018-08-30T09:51:59.737Z&time_updated=2018-08-30T09:51:59.737Z&label=*foo*&metadata=string&text=penguin&total=2 - POSTCreate spot list
/sets/spotlists - GETInfo for a specific spot list
/sets/spotlists/:id - PUTUpdate existing spot list
/sets/spotlists/:id - DELETEDelete spot list
/sets/spotlists/:id - GETGet spot ids for this list
/sets/spotlists/:id/ids - POSTAdd spots to an existing list
/sets/spotlists/:id/ids - DELETEDelete spot from list
/sets/spotlists/:id/ids/:itemId
spots
- GETGet all spots
/spots?after=2016-01-27T08:38:55.255Z&after_id=56a88364e783152127d15340&before=2016-01-27T08:38:55.255Z&before_id=56a88364e783152127d15340&from=2016-01-27T08:38:55.255Z&from_id=56a88364e783152127d15340&id_only=false&limit=5&populate=location,item&results_only=false&select=type,location.label&sort=-move_count,technology&until=2016-01-27T08:38:55.255Z&until_id=56a88364e783152127d15340&timeout_s=60&id=5b8d0b717503c445552a1865&time_created=2018-08-30T09:51:59.737Z&time_updated=2018-08-30T09:51:59.737Z&is_online=true&request_counter=1234&serial_number=1337 - GETGet spot
/spots/:id - PUTUpdate existing spot
/spots/:id - GETGet spotsets
/spots/:id/sets - POSTCreate spotset
/spots/:id/sets - GETGet spotset
/spots/:id/sets/:setId - PUTUpdate existing spotset
/spots/:id/sets/:setId
spotsets
- GETGet spotsets
/spotsets - POSTCreate spotset
/spotsets - GETGet spotset
/spotsets/:id - PUTUpdate existing spotset
/spotsets/:id
subscriptions
- GETGet all subscriptions
/subscriptions?after=2016-01-27T08:38:55.255Z&after_id=56a88364e783152127d15340&before=2016-01-27T08:38:55.255Z&before_id=56a88364e783152127d15340&from=2016-01-27T08:38:55.255Z&from_id=56a88364e783152127d15340&id_only=false&limit=5&populate=location,item&results_only=false&select=type,location.label&sort=-move_count,technology&until=2016-01-27T08:38:55.255Z&until_id=56a88364e783152127d15340&timeout_s=60&id=5b8d0b717503c445552a1865&time_created=2018-08-30T09:51:59.737Z&time_updated=2018-08-30T09:51:59.737Z&topic_filter=string&description=string&database_hold_time_h=0&populate_events=true&verify_target_certificate=true - POSTCreate subscription
/subscriptions - GETGet subscription
/subscriptions/:id - PUTUpdate existing subscription
/subscriptions/:id - DELETEDelete subscription
/subscriptions/:id - GETGet subscription events
/subscriptions/:id/events?after=2016-01-27T08:38:55.255Z&after_id=56a88364e783152127d15340&before=2016-01-27T08:38:55.255Z&before_id=56a88364e783152127d15340&from=2016-01-27T08:38:55.255Z&from_id=56a88364e783152127d15340&id_only=false&limit=5&populate=location,item&results_only=false&select=type,location.label&sort=-move_count,technology&until=2016-01-27T08:38:55.255Z&until_id=56a88364e783152127d15340&timeout_s=60&id=5b8d0b717503c445552a1865&time_created=2018-08-30T09:51:59.737Z&topic.resource_type=items&topic.action=created&topic.resource=5b7d6cbd7503c445552a1664&time_event=2018-08-30T09:51:59.737Z&time_expire=2018-08-30T09:51:59.737Z
users
- GETGet all users
/users?after=2016-01-27T08:38:55.255Z&after_id=56a88364e783152127d15340&before=2016-01-27T08:38:55.255Z&before_id=56a88364e783152127d15340&from=2016-01-27T08:38:55.255Z&from_id=56a88364e783152127d15340&id_only=false&limit=5&populate=location,item&results_only=false&select=type,location.label&sort=-move_count,technology&until=2016-01-27T08:38:55.255Z&until_id=56a88364e783152127d15340&timeout_s=60&id=5b8d0b717503c445552a1865&time_created=2018-08-30T09:51:59.737Z&time_updated=2018-08-30T09:51:59.737Z&email=string&first_name=string&last_name=string&is_admin=true&is_locked=trueCan only be used by an administrative user. - POSTCreate user
/usersCan only be used by an administrative user. - GETGet user
/users/:idCan only be used by an administrative user. - PUTUpdate existing user
/users/:idCan only be used by an administrative user. - DELETEDelete user
/users/:idCan only be used by an administrative user.
API details
- Authentication
- An API key in the brain.sid cookie
An API key in the X-Api-Key header
An API key in the key query parameter - Operations
- 77 operations on 40 pathsGET 37POST 15PUT 13DELETE 12
- Main resources
- sets 16spots 7blobs 6subscriptions 6items 5keys 5kvpairs 5locationrules 5locations 5users 5
- Response formats
application/jsonimage/*- Description format
- OpenAPI 3.0.1, API version
2.23.2+0.gfbc3926.dirty - Links
- Documentation · OpenAPI document · Support
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the Brain Web API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Brain Web API collection, without the publisher's secrets.
- Add your credentialsThis API uses an API key in the brain.sid cookie. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Authentication information” (GET /authinfo), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Brain Web API?
This document describes the [Intellifi Brain](https://intellifi.zendesk.com/hc/en-us/categories/360000685454) Web API specification using the [OpenAPI… It is listed under IoT & devices and has 77 endpoints.
Who publishes the Brain Web API?
It is listed from Intellifi's public API description (an OpenAPI document), not published by Intellifi on Swastik Codes. Anyone who controls intellifi.nl can claim the profile by adding a DNS TXT record.
How do I authenticate with the Brain Web API?
It accepts 3 methods: an API key in the brain.sid cookie; an API key in the X-Api-Key header; an API key in the key query parameter.
How many endpoints does the Brain Web API have?
77 operations on 40 paths (37 GET, 15 POST, 13 PUT, 12 DELETE). The largest groups are sets, spots, blobs, subscriptions.
Is forking the Brain Web API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.