АутентификацияPOST

Запустить аутентификацию по коду

Запускает поток входа по коду подтверждения. После этого вызова отправьте код через /auth/code; при необходимости 2FA — продолжите через /auth/password. WhatsApp использует тот же эндпоинт для сопряжения по номеру телефона — номер считывается из аккаунта (сохранённого при создании через provider_data.phone) и здесь его указывать не нужно.

https://api.unifyport.ai/v1/accounts/{account_id}/auth/start

Заголовки

X-Api-Key

stringобязательно

API-ключ рабочей области. Рабочая область определяется по этому заголовку.

Content-Type

stringобязательно

Используйте application/json при отправке JSON-тела запроса.

Параметры пути

account_id

stringобязательно

Идентификатор для маршрута раздела authentication.

Тело запроса

Этот эндпоинт не требует JSON-тела запроса.

Тело ответа

account_id

string

Аккаунт провайдера, к которому относится этот ответ.

status

string

Текущее состояние потока аутентификации, например awaiting_code, awaiting_qr_scan, authorized или cancelled.

auth_fields

object[]

Описывает, что требуется на следующем шаге — каждый элемент содержит type и признак обязательности.

auth_payload

object

Данные, необходимые клиенту для отрисовки следующего шага, например qr_code или verify_code.

expires_at

string

Метка времени RFC3339, после которой текущий auth_payload становится недействительным.

Ответы

200

200 OK

Запрос выполнен. См. пример тела ответа.

400

Bad Request

Тело запроса, путь или параметры некорректны.

401

Unauthorized

Заголовок X-Api-Key отсутствует или недействителен.

409

Conflict

Запрошенная операция конфликтует с существующим аккаунтом провайдера или ресурсом.

500

Internal Server Error

Сервис столкнулся с неожиданной ошибкой.

Запрос

curl -X POST https://api.unifyport.ai/v1/accounts/{account_id}/auth/start \
  -H "X-Api-Key: <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{}'

Ответ

{
  "data": {
    "account_id": "acc_example",
    "status": "awaiting_code",
    "auth_fields": [
      { "type": "code", "required": true }
    ],
    "auth_payload": {
      "verify_code": "ABCD-EFGH"
    },
    "expires_at": "2026-01-01T00:00:00Z"
  }
}