Перейти к содержимому

Забирать данные по API

Если данные нужно забирать программно — в свою CRM, BI или скрипт, — выпустите ключ API и обращайтесь к REST API кабинета. API только читает.

Вкладка «Интеграции» → блок «API для CRM и интеграций» → название ключа → «Выпустить ключ».

  • Ключ показывается целиком один раз, сразу после выпуска, — скопируйте его кнопкой «Скопировать». Дальше хранится только его отпечаток.
  • Ключей может быть несколько — по одному на интеграцию. У каждого — имя, начало ключа, дата выпуска и последний запрос; «Отозвать» гасит один ключ и не трогает другие.
  • Любой ключ видит весь кабинет.

Ключ передаётся в заголовке, а не в адресе:

Окно терминала
curl -H "Authorization: Bearer ВАШ_КЛЮЧ" \
"https://имя.goodwink.ru/api/v1/tables"

Вместо Authorization: Bearer можно слать X-Api-Key: ВАШ_КЛЮЧ.

Настройте отбор на экране таблицы (поиск, фильтры, период, сортировку, столбцы) и скопируйте параметры из адреса страницы — API вернёт те же строки. Вместо страниц экрана — limit и cursor:

Окно терминала
curl -H "Authorization: Bearer ВАШ_КЛЮЧ" \
"https://имя.goodwink.ru/api/v1/tables/sources/zayavki/rows?fc=summa&fo=gt&fv=1000&sort=summa&dir=desc&limit=100"

Пока в ответе has_more: true, передавайте next_cursor как cursor в следующий запрос с теми же остальными параметрами.

GET /api/v1/events отдаёт события по порядку приёма: первый раз — без cursor, с самого начала. next_cursor у ленты есть всегда — сохраните его и в следующий раз начните с него: придёт только новое.

Окно терминала
curl -H "X-Api-Key: ВАШ_КЛЮЧ" "https://имя.goodwink.ru/api/v1/events?limit=1000"
curl -H "X-Api-Key: ВАШ_КЛЮЧ" "https://имя.goodwink.ru/api/v1/events?limit=1000&cursor=СОХРАНЁННЫЙ_КУРСОР"

Повторную отправку (repeat_of не пуст) и историю (history: true) можно пропускать, как это делает вебхук.

  • Все параметры, форматы и коды ошибок — API: правила.
  • Каждая ручка с полями ответа — раздел «API: ручки» справочника.
  • Схема OpenAPI 3.1 для генераторов клиентов — GET /api/v1/openapi.json по тому же ключу.
  • Вместо опроса API платформа может сама слать события — вебхуком.