Метод API · v1

Проверка подключения

Проверка токена интеграции и доступности API Заездо. Успешный ответ подтверждает, что запрос авторизован. Метод не создаёт визиты и не открывает отдельный сеанс подключения.

GEThttps://app.zaezdo.pro/api/v1/ping

Bearer Token Без тела запросаHTTPS

Параметры ↓Запрос ↓Ответы ↓Ошибки ↓

На этой странице

Параметры и пример запроса#

HTTP

GET /api/v1/ping HTTP/1.1
Host: app.zaezdo.pro
Authorization: Bearer ВАШ_API_ТОКЕН
Accept: application/json

cURL · Bash / Git Bash

curl --request GET \
  --url "https://app.zaezdo.pro/api/v1/ping" \
  --header "Authorization: Bearer ВАШ_API_ТОКЕН"

Параметры пути, query-параметры и тело запроса отсутствуют. Передайте Bearer-токен в заголовке Authorization.

Успешный ответ#

HTTP 200 · JSON

{
  "status": "ok",
  "integration_id": "DEMO-INT-1C",
  "tenant_id": "CLIENT-DEMO",
  "version": "0.1.85"
}

Поле	Значение
status	Строка "ok": проверка подключения выполнена успешно.
`integration_id`	Идентификатор интеграции, для которой выпущен токен.
`tenant_id`	Идентификатор вашей компании в Заездо.
version	Версия серверного портала. Это не версия API. Значение 0.1.85 приведено как пример.

Коды и описания ошибок#

В действующем методе ping ошибка авторизации возвращается в поле detail.

`HTTP`	Условие	Точное значение detail
401	Нет заголовка Authorization или используется не Bearer.	Требуется Bearer-токен интеграции.
401	После Bearer не передано значение токена.	Токен интеграции не указан.
401	Токен недействителен, заменён или интеграция отключена.	Недействительный токен интеграции.
403	Компания отключена.	Компания отключена.

HTTP 401 · ТОКЕН НЕ ПЕРЕДАН

JSON

{
  "detail": "Требуется Bearer-токен интеграции."
}

Действия при получении ответа#

Ответ	Что делать
200, status: "ok"	Можно переходить к подготовке справочников и созданию визита.
401	Проверьте заголовок Authorization, токен и активность интеграции. Не повторяйте запрос без исправления причины.
403	Обратитесь к администратору Заездо: компания отключена.
500 / 502 / 503 / 504 или обрыв связи	Повторите `GET` после паузы. При повторяющемся сбое обратитесь в поддержку. `JSON`-тело для инфраструктурной ошибки не гарантируется.

Пример использования для 1С#

Получите токен в настройках интеграции: https://app.zaezdo.pro/settings/integration. Выполните запрос из раздела 3.1. При 200 и status: "ok" результат подключения считается успешным.

Передавайте токен в каждом следующем запросе.

← К соответствующему шагу «Быстрого старта»

← НазадБыстрый старт Далее →Получение пользователя