Skip to content

OpenAPI specification

The formal API contract is available in OpenAPI 3.0.3 format, compatible with Swagger UI, Postman, Insomnia, and client generators from the OpenAPI ecosystem.

Download

LanguageFile
Portuguêsopenapi.pt.yaml
Englishopenapi.en.yaml
Españolopenapi.es.yaml

The three versions have the same endpoints, methods, parameters, operationId values, schemas, authentication rules, and examples. The language changes only the summaries, descriptions, and group names; it does not change the language of the API responses.

Server

The server declared in the specification (https://api.example.com/directlink/v2) is illustrative. Before you generate a client or test calls, replace it with the host of your environment.

Interactive viewer