ESP Провайдеры

Создать аккаунт или пополнить кредиты

Создаёт новый аккаунт UChecker или пополняет кредиты существующему. Основной эндпоинт для ESP-провайдеров, вызываемый после подтверждения оплаты пользователем.

Логика работы:

  • Если аккаунт с указанным email не существует — создаётся новый аккаунт, генерируется API ключ, зачисляются кредиты. Поле is_new_account: true.
  • Если аккаунт существует — кредиты добавляются к текущему балансу. Поле is_new_account: false.

Идемпотентность: Передайте external_id (ID заказа на стороне ESP). При повторном вызове с тем же external_id кредиты не будут зачислены повторно — вернётся исходный ответ с is_duplicate: true.

Возвращаемые данные: Ответ содержит api_key аккаунта — передайте его пользователю для доступа к API. Также возвращаются credits_added (зачислено) и total_credits (итоговый баланс).

Аутентификация: Требуется токен ESP-провайдера в заголовке x-esp-token.

post/api/v1/esp/provision

Request

  • Base URL: https://api.uchecker.net
  • URL: https://api.uchecker.net/api/v1/esp/provision
  • Auth: none declared. Required headers: x-esp-token

Headers

x-esp-tokenstring required

Токен аутентификации ESP-провайдера. Выдаётся при регистрации партнёра.

Request body

emailstring required

Email-адрес пользователя. Если аккаунт с таким email существует — кредиты будут добавлены к текущему балансу. Если нет — будет создан новый аккаунт.

creditsnumber required

Количество кредитов для зачисления на аккаунт. 1 кредит = 1 проверка email-адреса.

external_idstring

Внешний идентификатор заказа/транзакции на стороне ESP-провайдера. Используется для идемпотентности — повторный запрос с тем же external_id не создаст дубликат.

Example request

{
  "email": "user@example.com",
  "credits": 10000,
  "external_id": "order_12345"
}

Response

Аккаунт создан или пополнен. Ответ содержит API ключ, зачисленные и итоговые кредиты.

successboolean required

Признак успешного выполнения операции

messagestring required

Человекочитаемое описание результата

account_idnumber required

Числовой идентификатор аккаунта UChecker

emailstring required

Email-адрес аккаунта

api_keystring required

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

credits_addednumber required

Количество кредитов, зачисленных в рамках этой операции

total_creditsnumber required

Итоговый баланс кредитов на аккаунте (включая ранее зачисленные)

is_new_accountboolean required

true — создан новый аккаунт, false — кредиты добавлены к существующему

is_duplicateboolean

true — запрос с таким external_id уже обработан ранее. Кредиты не были зачислены повторно (идемпотентный ответ).

Example response

{
  "success": true,
  "message": "Аккаунт создан и лимиты зачислены успешно",
  "account_id": 123,
  "email": "user@example.com",
  "api_key": "uk_xxxxxxxxxxxxx",
  "credits_added": 10000,
  "total_credits": 10000
}

Changes

No recorded changes to this operation across all 1 revision of this API.