API Documentation#
This page includes links to LUNA PLATFORM RESTful API reference manuals for each of the services. Engeneers and programmers should familiarise themselves with these documents to find out about LP features and their implementation.
These documents:
- include current API version,
- provide information about available resources, methods and parameters,
- describes the required input data,
- give an explanation for each field field,
- give examples of request and response bodies.
LUNA PLATFORM uses HTTP protocol for requests and responses.
Account ID#
When performing a request that changes the database, it is required to specify a "Luna-Account-Id". The created data will be related to the specified account ID.
You should use the account ID when requesting information from LP to receive the information related to the account.
The account ID is created according to the UUID format.
API specifications#
API specifications are provided in two formats: HTML and YML.
The documents in HTML format provide a visual representation of API specifications and may be incomplete.
The documents in YML format provide a valid specification for LUNA PLATFORM. You can import the file to an external application for requests creation (e. g., Postman) or visualize using special tools (e. g., https://editor.swagger.io/).
HTML and YML documents corresponding to the same service have the same names.
The following table includes links to API reference manuals provided in HTML format.
| Document name | Description | Link to the document |
|---|---|---|
| API service reference manual | General requests to LUNA PLATFORM API service | APIReferenceManual |
| Sender service reference manual | Subscription to events using WebSocket protocol | SenderReferenceManual |
| Admin service reference manual | Administrative requests performed for all the accounts | AdminReferenceManual |
| Backport 4 service reference manual | Requests emulating LUNA PLATFORM 4 requests | Backport4ReferenceManual |
| Backport 3 service reference manual | Requests emulating LUNA PLATFORM 3 requests | Backport3ReferenceManual |
| Configurator service reference manual | Requests for managing Configurator entities | ConfiguratorReferenceManual |
| Faces service reference manual | Requests related to faces, lists, and attributes | FacesReferenceManual |
| Tasks service reference manual | Requests related to long tasks | TasksReferenceManual |
| Handlers service reference manual | Requests related to handlers. | HandlersReferenceManual |
| Events service reference manual | Requests related to events | EventsReferenceManual |
| Image Store service reference manual | Requests related to storing data in Image Store | ImageStoreReferenceManual |
| Python Matcher service reference manual | Requests related to matching | PythonMatcherReferenceManual |
| Licenses service reference manual | Requests for receiving information about license | LicensesReferenceManual |
The following table includes links to API specifications provided in YML format.
| Document name | Description | Link to the document |
|---|---|---|
| API service API specification | General requests to LUNA PLATFORM API service | APIReferenceManual.yml |
| Sender service API specification | Subscription to events using WebSocket protocol | SenderReferenceManual.yml |
| Admin service API specification | Administrative requests performed for all the accounts | AdminReferenceManual.yml |
| Backport 4 service API specification | Requests emulating LUNA PLATFORM 4 requests | Backport4ReferenceManual.yml |
| Backport 3 service API specification | Requests emulating LUNA PLATFORM 3 requests | Backport3ReferenceManual.yml |
| Configurator service API specification | Requests for managing Configurator entities | ConfiguratorReferenceManual.yml |
| Faces service API specification | Requests related to faces, lists, and attributes | FacesReferenceManual.yml |
| Tasks service API specification | Requests related to long tasks | TasksReferenceManual.yml |
| Handlers service API specification | Requests related to handlers. | HandlersReferenceManual.yml |
| Events service API specification | Requests related to events | EventsReferenceManual.yml |
| Image Store service API specification | Requests related to storing data in Image Store | ImageStoreReferenceManual.yml |
| Python Matcher service API specification | Requests related to matching | PythonMatcherReferenceManual.yml |
| Licenses service API specification | Requests for receiving information about license | LicensesReferenceManual.yml |