Руководства
Как читать документацию API Kratk
Приоритет: /admin/api-docs и /docs/api — не устаревшие гайды; поля ответа проверяйте экспериментом.
Документация разрознена
В интернете или старых MD могут быть неверные endpoint. Команда интегрирует несуществующий webhook или bulk endpoint.
Иерархия источников
1) кабинет API — эталон curl. 2) /docs/api и дочерние страницы. 3) Ответ реального запроса. Блог — паттерны, не контракт.
Пошаговая инструкция
- Найдите сценарий в обзоре (links, inbox).
- Откройте узкую страницу, напр. create link.
- Сверьте curl в /admin/api-docs.
- Сделайте пробный запрос; зафиксируйте JSON schema ответа у себя.
- При расхождении — верьте кабинету, не статье.
Практический пример
Нужен bulk — в справке нет отдельного bulk endpoint → цикл POST или уточнение в support; не выдумываете PUT /bulk.
Типичные ошибки
- Hardcode base URL без проверки prod.
- Игнор лимитов у ключа в UI.
- Ожидание analytics API без проверки docs.
- Копирование Bearer в клиентское приложение.
FAQ
Что если поле есть в UI, но не в curl?
Проверьте обновлённый пример в кабинете; необязательные поля могут добавляться без анонса в блоге.
Inbox API?
Отдельный сценарий: Inbox API.
Вывод
Контракт API = кабинет + /docs/api. Блог описывает как применять, не заменяет справку.
Нужна короткая ссылка?
В Kratk можно создать ссылку и смотреть переходы в аналитике. Статья полезна и без регистрации.