REST API предоставляет программный доступ к данным вашей компании. Он предназначен для разработчиков, создающих интеграцию; для повседневной работы он не нужен.
- Справочник API: полный справочник публично доступен по адресу /docs/api вашего рабочего пространства, документ OpenAPI — по адресам /docs/api/openapi.yaml и /docs/api/openapi.json. Ссылка на него есть в разделе API и вебхуки в настройках.
- Базовый URL: указан вверху раздела API и вебхуки. Он заканчивается на /api/v1.
- Аутентификация: передавайте заголовок Authorization: Bearer, за которым следует ваш токен, и Accept: application/json.
- Ответы: только JSON. Отдельные записи обёрнуты в data; списки дополнительно содержат meta и links для курсорной пагинации (параметры limit и cursor, до 100 записей на страницу).
- Безопасные повторы: передавайте заголовок Idempotency-Key в запросах POST. Повтор того же запроса с тем же ключом возвращает сохранённый ответ вместо создания второй записи. Ключи хранятся 24 часа.
- Ограничение частоты: 120 запросов в минуту на токен. Заголовки X-RateLimit-Limit и X-RateLimit-Remaining показывают текущее состояние; при превышении лимита возвращается 429 с заголовком Retry-After.
Что может делать запрос
Вызов выполняется успешно, только если у токена есть право (например, invoices:write), а у пользователя токена есть соответствующее разрешение в приложении. Действуют те же бизнес-правила, что и на экране, поэтому выставленный счёт нельзя изменить и через API.
Связанные руководства
Спросить о продукте
Спросите, что умеет программа, как выполняется задача или какие страны и языки она поддерживает. Ответы основаны на этих руководствах.
Думаю…
ИИ-ассистент сейчас недоступен. Поищите в руководствах или свяжитесь с нашей командой. Связаться с поддержкой
ИИ может ошибаться. Проверяйте по ссылкам на руководства.
Всё ещё нужна помощь?
Служба поддержки читает каждое сообщение и отвечает понятным языком.
Связаться с поддержкой