Meiro Integrations API
Home of all MI functions accessible over the API respective to the components of Meiro.
Base URL
https://api.instance_name.meiro.io/
Home of all MI functions accessible over the API respective to the components of Meiro.
- User - management of users of the system
- Workspace - basic element of Meiro - set configurations creating the whole data workflow
- Component - class or template for configuration
- Configuration - configured component as concrete implementation of one piece of data workflow
- OAuth Repository - repository of applications used in OAuth authentication workflow
instance_name in API URL should be replaced by the required instance.
Quick Request
Authentication
Authentication is based on API token sent in header. The token must be present in all requests to the API.
Pagination
All requests returning collections of records have optional parameters limit and offset for paging. Default number of records returned by API of the collection is 20 and they are ordered from the newest to oldest = descending based on timestamp.
Plain/Full data response
Returned entity data are plain by default - the sub-entities are represented only by their ID. If you want to retrieve data of sub-entities, set parameter load_full_structure to 1.
Media Types
Communication of API is entirely in application/json - both Request Body and Response Body where applicable are in JSON.
Error States
The common HTTP Response Status Codes are used.