Документация по API Kaizala

Статья
04/04/2023

Прежде чем приступить к работе, ознакомьтесь с разделом Настройка использования соединителей Kaizala.

Корневой домен

Корневой домен для вызова API Kaizala:

{endpoint-url}

	Параметр	Тип	Дополнительные?	Описание
URL-адрес конечной точки	`endpoint-url`	Строка	Нет	При успешной проверке подлинности при создании маркеров доступа возвращается URL-адрес конечной точки, который следует использовать в качестве api-base-url для последующих вызовов API.

При использовании любого API Kaizala вы можете получить код состояния HTTP:308, указывающий, что url-адрес конечной точки пользователя изменился. В этом случае расположение заголовка ответа будет содержать новый URL-адрес конечной точки.

Предложение: Клиенты могут настроить время ожидания для получения ответа от API Kaizala в 1 мин.

Конечные точки API

API Kaizala работает в безопасном облаке Microsoft Azure и взаимодействует с платформой Kaizala для выполнения различных действий для конечных пользователей. API работает со следующими ресурсами Kaizala:

Api Kaizala имеет ограничения регулирования

100 вызовов в минуту на соединитель
300 вызовов в минуту на клиента (между соединителями)

При превышении ограничения регулирования API вернет значение "Повторить-после" вместе с кодом состояния HTTP:429. Значение "Retry-After" указывает, сколько секунд нужно ждать перед выполнением другого запроса.

Веб-перехватчики

API Microsoft Kaizala также предоставляет разработчикам возможность регистрироваться для получения определенных событий на платформе Kaizala с помощью веб-перехватчиков.

/webhook

Коллекция Postman

Чтобы протестировать наши API, а также понять схему API Kaizala, можно импортировать коллекцию postman, содержащую примеры и схему для всех API Microsoft Kaizala:

Перед запуском проекта postman задайте следующие переменные среды в Kaizala-APIIs-environment:

mobile-number: ваш номер мобильного телефона, который будет использоваться для вызова API.
идентификатор приложения: идентификатор, связанный с соединителем
секрет приложения: секрет, связанный с соединителем

Другие переменные среды будут заполняться автоматически при попытке последовательного упоминания API в Postman Project.

Начало работы с REST API Kaizala

Пример C# (общий)