Аутентификация
Передайте API-ключ в качестве маркера носителя (bearer token). Эта конечная точка не указывает конкретное разрешение в спецификации, поэтому предоставьте своему ключу минимум необходимых прав и проверьте ответ, вместо того чтобы делать предположения.
Этот эндпоинт не принимает идентификатор организации. Ваш ключ уже определяет организацию, к которой он принадлежит, и ответ ограничивается ее рамками.
Попробовать
Замените всё в угловых скобках на собственные значения, а плейсхолдер ключа — на ключ из вашей панели управления.
curl -X POST https://api.zinndigital.com/v1/seo/quota/top-up \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "quantity": <integer> }'Вошли в систему? Консоль API в вашей панели управления автоматически подставляет реальный идентификатор вашей организации и ваш собственный ключ, а также выполняет запрос к работающему API, чтобы вы могли увидеть актуальный ответ. Откройте эту конечную точку в API-консоли
Подробнее
Buys a pack of additional lookups, paid from the account credit balance. Purchased lookups do not expire and are spent only once the daily plan allowance is used up. Idempotent on the `Idempotency-Key` header: repeating a request with the same key returns the same purchase rather than buying a second pack. `422` when the pack size is not sold or the credit balance does not cover it — in which case nothing is charged at all.
Параметры
| Имя | Тип | Обязательно | Что это |
|---|---|---|---|
Idempotency-Key (header) | string | Нет | Caller-supplied replay key. Strongly recommended: without one, a retried request buys a second pack. |
Тело запроса
| Имя | Тип | Обязательно | Что это |
|---|---|---|---|
quantity | integer | Да | The pack size to buy. Must be one offered by `GET /v1/seo/quota`. |
Ответ
| Имя | Тип | Обязательно | Что это |
|---|---|---|---|
daily_allowance | integer | Да | Lookups included per day. `-1` means unlimited. |
used_today | integer | Да | Plan-funded lookups run since midnight UTC. |
plan_remaining | integer | Нет | — |
top_up_remaining | integer | Нет | Purchased lookups still unspent. These do not expire. |
remaining | integer | Да | — |
is_unlimited | boolean | Нет | — |
can_look_up | boolean | Да | Whether a lookup would be permitted right now. **Not** the same as `remaining > 0`: a suspended or unpaid account may have lookups left and still be refused. |
in_good_standing | boolean | Нет | — |
packs | object[] | Да | Packs of extra lookups available to buy. |
Ошибки, которые может возвращать этот эндпоинт
401 · 403 · 422