Informer 5 API How to get connected and start integrating Brad Leupen | Entrinsik Inc. | February 12, 2018

Overview Basic Concepts How To Connect Examples!

Basic Concepts API – Application Programming Interface. Services that allow you to access the application logic directly. REST – REpresentational State Transfer (a web-based API) Authentication – Verifying you are who you say you are Authorization – Verifying you can do what you want to do Access Token – A preauthenticated hall pass to do a specific thing in Informer

REST REST is just nouns and verbs The nouns are URLs Collections of things: /api/datasets Or individual items: /api/datasets/admin:northwind-orders The verbs are HTTP Methods and there are really just four to worry about: GET – reads an item or items PUT – updates an item DELETE – removes an item POST – creates an item or performs an action

Access Tokens View and generate them from your profile page Shortcuts to create specific types of tokens appear throughout the application Guard your tokens (especially full API tokens) Consider restricting access to certain hosts

Accessing the API View (and try!) all API endpoints using our API documentation at /documentation All visual routes are organized under the /v namespace Paste your API token into the token parameter. Postman is an excellent tool to help create REST queries

Example 1 The Embedded Chart

Example 2 The Embedded Dashboard

Example 3 The On-Demand Chart

Example 4 The Mapping Suite Query

Example 5 The On-Demand Dataset

Example 6 Accessing Users