API

Last updated: November 26, 2024

Работа с API

Developers can interact with the web service through programmatic requests using API description standards. The API interface complies with the OpenAPI version 3 specification and has a Swagger interface for development and debugging.

OpenAPI Specification (OAS) 3

General API Description: The OpenAPI specification provides a clear and understandable description of your API, including available endpoints, methods (GET, POST, PUT, DELETE, and others), query parameters, headers, response codes, and data types.

Specification structure:

  • Version: Specifies the version of the specification..
  • Info: Contains metadata about your API, such as name, version, and description.
  • ХHost and Path Base: Specifies the base URL and context path of the API.
  • Endpoints: Describes each available API resource, its methods, and possible parameters and responses.

Swagger interface

Swagger UI provides a visual interface where you can explore the API, see available endpoints, and run test requests directly from your browser. You can enter the required parameters, send requests, and view responses, making it easier to understand how the API works and test its functionality. If the API specification is updated, Swagger UI automatically reflects these changes, providing up-to-date information.

Quick start

Here is all the information you need to get started.

  • Endpoint address https://cloud.alviy.com/api/v1.
  • Documentation and Swagger interface/docs/api
  • The token for work is available for authorized users at the link