Внешний API

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

Это единственный раздел документации, написанный для разработчика. Остальные описывают те же сущности со стороны интерфейса.

Базовый адрес

Все методы живут на адресе вашего контура:

https://ваш-контур.warpref.ru/api/external

Где взять ключ доступа

Ключ создаётся в админке, в настройках — раздел с ключами API. Ключей может быть несколько: удобно завести отдельный на каждую интегрируемую систему, чтобы потом отключать их по одному.

Значение показывается один раз при создании — сохраните его сразу, повторно посмотреть его нельзя. Потерянный ключ не восстанавливают, а заводят заново.

Ключ можно деактивировать, не удаляя: деактивированный перестаёт работать немедленно, а история его использования остаётся.

Как авторизоваться

Ключ передаётся заголовком x-api-key в каждом запросе:

GET /api/external/partner HTTP/1.1
Host: ваш-контур.warpref.ru
x-api-key: ваш-ключ

Возможные ответы при неудачной авторизации:

Ситуация	Ответ
заголовок `x-api-key` не передан	`401`, «x-api-key не передан»
такого ключа нет	`401`, «API-ключ не найден»
ключ деактивирован	`401`, «API-ключ деактивирован»

Какие методы есть

Метод	Путь	Что делает
`GET`	`/lead-fields`	список полей лида, настроенных в вашем контуре
`POST`	`/lead`	создать лид
`PUT`	`/lead/{id}/status`	сменить статус лида
`PUT`	`/lead/{id}/add-deal`	добавить сделку к лиду
`GET`	`/partner`	список партнёров контура
`GET`	`/payout`	список выплат
`POST`	`/payout`	создать выплату
`PUT`	`/payout/{id}/status`	сменить статус выплаты: подтвердить, отметить выплаченной или отклонить

{id} во всех методах — UUID.

Читать также

Лиды — полное описание методов для заявок
Партнёры и Выплаты — методы для партнёров и выплат
ЛК администратора — где создаются ключи и настраиваются поля лида
Консоль — тариф и доступ к API