Skip to main content
Version: 0.6.2

Niara API

Examples​

Example of an API call using curl:

curl -X POST https://api.niara.tech/prod/test -H accept: application/json -H Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyXXXX

WebHook Notification​

This API describes the schema for webhook calls sent by Niara when a event occurs.

The endpoint is intended for integration partners to understand the structure of webhook payloads, enabling correct processing and validation of incoming data.

You can set the webhook URL in the Niara Configurations -> Fluxo de Compra -> Regras de Notificação screen.

Note: This API does not accept requests; it is for documentation purposes only.

Lost Reservation Flow

Examples:

{
  "orderId": "BBOILYE",
  "eventyType": "ORDER_CHANGED"
}
{
  "orderId": "BBOILYE",
  "eventyType": "LOST_RESERVATION_CHANGED"
}

Authentication​

Each request to the API must include an authentication token provided by the Niara team. The token is associated with a client registered in the Niara system.

The client must include this token in the Authorization header when making API requests:

Authorization: Bearer <token>

The token follows the JSON Web Token (JWT) format and its length may vary (between 640 and 2,000 characters).

Security Scheme Type:http
HTTP Authorization Scheme:bearer
Bearer format:JWT