apiid: что это
apiid — необязательный параметр запроса, в который вы кладёте номер заявки из своей системы. Благодаря ему повтор запроса не создаёт второй лид, а возвращает номер первого.
Определение
Когда вы отправляете заявку, у неё уже есть номер в вашем трекере или CRM. Если передать его в apiid, сеть запомнит связь «ваш номер — наш lead_id». Следующий запрос с тем же значением будет узнан как повтор.
Пример
Запрос: …/api/lead?wmkey=…&apikey=…&offer_id=1&city=Самара&phone=79271234567&apiid=trk-123. Первый ответ: { "status": "ok", "lead_id": 443110 }. При повторе с apiid=trk-123 придёт тот же lead_id и признак duplicate_of_request. Вторая заявка не создаётся.
Как формировать значение
- Используйте стабильный номер заявки или клика: тот, что не меняется при повторах.
- Не берите время отправки или случайные числа: при повторе значение изменится.
- Избегайте пробелов и спецсимволов, чтобы не терять значение при кодировании ссылки.
Нюансы
Параметр защищает именно от повторов запроса. Если человек оставил заявку дважды и у вас это два разных номера, сработает проверка дубля по телефону: за 30 дней по тому же офферу заявка получит отказ duplicate. Повторять такой запрос не нужно.
Практический совет
Если ваш трекер не умеет подставлять собственный номер, используйте номер клика или внутренний идентификатор записи. Главное, чтобы он однозначно указывал на одну заявку и не менялся между повторами.
Связанные понятия
Идея описана в статье про идемпотентность. Ответ содержит lead_id, а статус лида приходит в постбэк тем же значением %apiid%, что удобно для сверки в трекере. Подробности — в документации API.
Вопросы и ответы
Что произойдёт, если не передавать apiid?
Заявка примет и без него, но при повторе запроса из-за сбоя сети защиты от дубля по идентификатору не будет.
Приходит ли apiid в постбэке?
Да, для этого есть макрос %apiid%. Он помогает сопоставить статус с заявкой в вашем трекере.