Документация/Подключение/Своя панель/Примеры·7 / 9

Примеры

Частые задачи вашей системы и поддержки — по одной-две команды. Адрес и токен — в переменных, как на странице «Вызовы».

  1. Завести клиента

    На месяц, три устройства, с номером заказа во внешнем ID. Ключ повтора — номер заказа: повторный запрос получит тот же ответ, а не второго клиента.

    На вашем сервере
    curl -s "$VELI/clients" \
      -H "Authorization: Bearer $VELI_TOKEN" \
      -H "content-type: application/json" \
      -H "Idempotency-Key: order-88123:new" \
      -d '{"name": "order-88123", "days": 30, "change": {"devices": 3, "external": "88123", "tags": ["month"], "meta": {"order": "88123"}}}'
  2. Продлить на месяц

    Срок прибавится к концу, у истёкшего — от сейчас. С ключом повтор запроса не продлит дважды.

    На вашем сервере
    curl -s "$VELI/clients/order-88123" \
      -H "Authorization: Bearer $VELI_TOKEN" \
      -H "content-type: application/json" \
      -H "Idempotency-Key: order-88123:extend" \
      -d '{"change": {"days": 30}}'
  3. Ссылка, QR и кнопки приложений

    Ссылка — в link, страница с кнопками — в page, готовые ссылки «Добавить в …» — в apps, остаток — в left. QR-код для чата или письма — PNG.

    На вашем сервере
    curl -s "$VELI/clients/order-88123" \
      -H "Authorization: Bearer $VELI_TOKEN" | jq -r .link
    curl -s "$VELI/clients/order-88123/qr?format=png&size=512" \
      -H "Authorization: Bearer $VELI_TOKEN" -o qr.png
    curl -s "$VELI/clients/order-88123" \
      -H "Authorization: Bearer $VELI_TOKEN" | jq '{page, apps, left}'
  4. Найти клиентов по внешнему ID

    Подписок у человека может быть несколько — ответ всегда список.

    На вашем сервере
    curl -s "$VELI/clients?external=88123" \
      -H "Authorization: Bearer $VELI_TOKEN" | jq -r '.clients[] | "\(.name) \(.status) \(.left.days)"'

Повтор без последствий

Системы присылают уведомление повторно, люди нажимают дважды, сервер падает между запросом и ответом. Заголовок Idempotency-Key у POST делает повтор безопасным.

  • Тот же ключ и тот же запрос — тот же ответ, без второго действия, с заголовком Idempotent-Replayed: true.
  • Тот же ключ с другим запросом — 409 idempotency: ключ уже потрачен на другое.
  • Панель помнит ключ сутки, у каждого токена свои ключи. Ключ — до 128 видимых знаков; удобно — номер заказа и действие: order-88123:extend.
  • Ключ — на одно действие: у продления и у заведения ключи разные, иначе второй запрос получит ответ первого.
Повтор с тем же ключом
HTTP/1.1 200 OK
idempotent-replayed: true

{"done": 1}