Requests

Make sure the request body includesContent-Type: application/json

All operations follow this address pattern:

[ApiAddress]/v2/[ResourceType]/[GUID?]|[Operation?]
  • ApiAddress Base address of the MyLuxura API.

  • ResourceType Logical group of operation, in most cases identifies target of operations.

  • GUID (optional) The globally unique identifier of a document, which indicates you're performing an action on that document or regarding that document.

  • Operation (optional) Name of the operation to be performed.

HTTP methods

The following HTTP methods are supported by the API.

Method

Description

GET

Fetching a document, without updating its content.

POST

Creating a document.

PATCH

Updating the content of a document.

PUT

Performing an action that'll impact the document or its content.

DELETE

Removing a document.

Authorization

The way of authentication with the MyLuxura API is via the Authorization header (more detailsarrow-up-right). You are required to create a personal access token and use that in the Headers section of your HTTP request, as described below. For tokens, the type Bearer is used (see RFC-6750arrow-up-right).

circle-info

Permissions and resources are linked to companies. Please read Companies & permissions carefully before using or implementing this API.

Last updated

Was this helpful?