API Documentation#
This page includes links to LUNA PLATFORM 5 and LUNA Index Matching Module 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.
Authorization#
Almost all requests made to LP 5 require authorization. There are three types of authorization available in LUNA PLATFORM:
- BasicAuth. Authorization by login and password (set during account creation).
- BearerAuth. Authorization by JWT token (issued after the token is created).
- LunaAccountIdAuth. Authorization by "Luna-Account-Id" header, which specifies the "account_id" generated after creating the account.
LunaAccountIdAuth authorization has the lowest priority compared to other methods and can be disabled using the "ALLOW_LUNA_ACCOUNT_AUTH_HEADER" setting in the "OTHER" section of the API service settings in the Configurator (enabled by default). In OpenAPI specification the "Luna-Account-Id" header is marked with the word Deprecated.
There is no need to use all three types of authorization when making requests. You must choose the preferred method depending on the required tasks.
In order to use one of the types of authorization, you must have an account. The account is created using the POST request "create account" to the API service, POST request "register account" to the Admin service or using Admin GUI.
If the authorization type is not specified in the request, an error with a 403 status code will be returned.
See the "Accounts, tokens and authorization types" section of the administrator manual for detailed information about accounts.
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 and LIM. 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.
LP API specifications#
The following table includes links to API reference manuals provided in HTML format.
| Document name | Description | Link to the document in HTML format |
|---|---|---|
| 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 in YML format |
|---|---|---|
| API service API specification | General requests to LUNA PLATFORM API service | APIReferenceManual.yml |
| Sender service API specification | Subscription to events using WebSocket protocol | SenderReferenceManual |
| Admin service API specification | Administrative requests performed for all the accounts | AdminReferenceManual |
| Backport 4 service API specification | Requests emulating LUNA PLATFORM 4 requests | Backport4ReferenceManual |
| Backport 3 service API specification | Requests emulating LUNA PLATFORM 3 requests | Backport3ReferenceManual |
| Configurator service API specification | Requests for managing Configurator entities | ConfiguratorReferenceManual |
| Faces service API specification | Requests related to faces, lists, and attributes | FacesReferenceManual |
| Tasks service API specification | Requests related to long tasks | TasksReferenceManual |
| Handlers service API specification | Requests related to handlers. | HandlersReferenceManual |
| Events service API specification | Requests related to events | EventsReferenceManual |
| Image Store service API specification | Requests related to storing data in Image Store | ImageStoreReferenceManual |
| Python Matcher service API specification | Requests related to matching | PythonMatcherReferenceManual |
| Licenses service API specification | Requests for receiving information about license | LicensesReferenceManual |
LIM API specifications#
The following table includes links to API reference manuals provided in HTML format.
| Document name | Description | Links to the documents |
|---|---|---|
| Index Manager service reference manual | Requests related to index building tasks and interactions with the created indexes | IndexManagerReferenceManual |
| Indexer service reference manual | Requests related to index building | IndexerReferenceManual |
| Indexed Matcher service reference manual | Requests related to index matching | IndexedMatcherReferenceManual |
The following table includes links to API specifications provided in YML format.
| Document name | Description | Link to the document in YML format |
|---|---|---|
| Index Manager service reference manual | Requests related to index building tasks and interactions with the created indexes | IndexManagerReferenceManual |
| Indexer service reference manual | Requests related to index building | IndexerReferenceManual |
| Indexed Matcher service reference manual | Requests related to index matching | IndexedMatcherReferenceManual |