Справочник API
API v1Эндпоинты, аутентификация и ответы.
Основы
- ОбзорБазовый адрес, форма запроса и ответа и соглашения, которым следует каждая операция API.4 мин
- АутентификацияКак запрос сообщает, кто он, — API-ключ, единственный проект, в котором ключ действует, и разрешения, которые говорят, что ему можно.3 мин
- ЗапросыКакие заголовки отправляет запрос и несёт ответ, как длинный список читается по страницам и сколько запросов может отправить ключ.3 мин
- ИдемпотентностьЗаголовок Idempotency-Key — каким запросам он нужен, чем отвечают на повторный запрос и как выбрать ключ.3 мин
- Коды ошибокКонверт ошибки, откуда берётся её код, и каждый код, которым отвечает API, — что он значит и что с ним делать.4 мин
- ВебхукиЧто несёт доставка вебхука, как проверить её подпись, когда её отправляют снова и о чём сообщает каждое семейство событий.6 мин
- Спецификация OpenAPIЧто содержит документ OpenAPI для Slen API, как из него собраны страницы этого раздела и как читать страницу операции.2 мин
Ресурсы
- ОперацииОтправьте запрос через флоу, привязанный к коду операции, прочитайте операции — вызовы модели во флоу — со всеми попытками за ними и получите список холдов этих вызовов.
- ВыполненияЧитайте статус выполнения, пока оно идёт, и его трассировку по узлам, когда оно продвинулось.
- Клиенты и кредитыДобавляйте своих клиентов, ведите их счета кредитов, пополняйте, списывайте и корректируйте их кредиты, блокируйте клиента и задавайте, сколько кредитов стоит операция.
- СогласованияПолучите список запросов на согласование, которых ждут выполнения, и одобрите или отклоните запрос.
- МоделиПрочитайте, какие модели может назвать запрос и по какой цене каждая из них считается сейчас.
- ФлоуСоздайте флоу, сохраните его черновик, проверьте и опубликуйте его, откатите его, дайте ему код операции и читайте его выполнения и аналитику.
- БюджетыПолучите список бюджетов с тем, что от них осталось, создайте бюджет, измените его лимит, отправьте его в архив или восстановите.
- ОповещенияПрочитайте ленту оповещений, которые открылись в проекте, и отметьте оповещение как просмотренное.
- АналитикаПрочитайте, сколько потратил проект, чем закончились его выполнения, насколько точными были оценки его вызовов модели и во что обошлись его клиенты.
- Записи реестраПрочитайте журнал денег, которые проект зарезервировал, вернул и потратил, запись за записью.
- Подключения провайдеровСохраните API-ключ провайдера моделей, проверьте, что он работает, задайте его лимиты и на время выведите его из работы.
- Пулы провайдеровСоздайте пул подключений провайдеров, расставьте его участников, прочитайте их текущий запас и то, как пул обслуживал вызовы.
- Проверки состоянияДве проверки состояния, которым не нужен ключ, говорят, отвечает ли API и отвечают ли его зависимости, а одна операция — что происходит, пока реестр недоступен.