Схема API

GET

/api/v1/openapi.json

curl --request GET \
  --url https://demo.goodwink.ru/api/v1/openapi.json \
  --header 'Authorization: Bearer <token>'

• адрес вашего кабинета

Этот документ — по ключу

Authorizations

• bearer
• apiKey

Responses

200

Успех

Media typeapplication/json

object

Example ^generated

{}

Headers

X-RateLimit-Limit

integer

Лимит запросов в минуту на ключ

X-RateLimit-Remaining

integer

Сколько осталось в этой минуте

401

Нет ключа, ключ неверный или отозван; WWW-Authenticate: Bearer

Media typeapplication/json

object

error

required

object

type

required

string

Allowed values: invalid_request unauthorized not_found conflict rate_limited unavailable

code

required

Машинный код: unknown_param, bad_limit, bad_cursor, bad_source_id, bad_channel, bad_filter, bad_fo, bad_fv, bad_dir, bad_period, unknown_column, bad_columns, bad_selection, invalid_key, rate_limited, no_such_source, no_such_table, table_busy, query_failed, query_timeout, reader_off

string

message

required

Что ждали — словами

string

param

required

Виноватый параметр

string | null

Example

{
  "error": {
    "type": "invalid_request"
  }
}

429

Превышен лимит запросов на ключ; Retry-After — через сколько секунд

Media typeapplication/json

object

error

required

object

type

required

string

Allowed values: invalid_request unauthorized not_found conflict rate_limited unavailable

code

required

Машинный код: unknown_param, bad_limit, bad_cursor, bad_source_id, bad_channel, bad_filter, bad_fo, bad_fv, bad_dir, bad_period, unknown_column, bad_columns, bad_selection, invalid_key, rate_limited, no_such_source, no_such_table, table_busy, query_failed, query_timeout, reader_off

string

message

required

Что ждали — словами

string

param

required

Виноватый параметр

string | null

Example

{
  "error": {
    "type": "invalid_request"
  }
}