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

API кілтін bearer токені ретінде жіберіңіз. Бұл соңғы нүкте сипаттамада арнайы рұқсатты көрсетпейді, сондықтан болжағаннан гөрі кілтіңізге қажетті ең аз рұқсатты беріп, жауапты тексеріңіз.

Бұл соңғы нүкте ұйым идентификаторын қабылдамайды. Сіздің кілтіңіз оның қай ұйымға тиесілі екенін өзі анықтайды және жауап соған шектеледі.

Әрекет етіп көру

Бұрыштық жақшалардағы кез келген нәрсені өз мәндеріңізбен, ал кілт орналастырушысын басқару тақтасынан алынған кілтпен алмастырыңыз.

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.

Параметрлер

АтыTүріМіндеттіМазмұны
Idempotency-Key (header)stringЖоқCaller-supplied replay key. Strongly recommended: without one, a retried request buys a second pack.

Сұрау денесі

АтыTүріМіндеттіМазмұны
quantityintegerИәThe pack size to buy. Must be one offered by GET /v1/seo/quota.

Жауап

АтыTүріМіндеттіМазмұны
daily_allowanceintegerИәLookups included per day. -1 means unlimited.
used_todayintegerИәPlan-funded lookups run since midnight UTC.
plan_remainingintegerЖоқ
top_up_remainingintegerЖоқPurchased lookups still unspent. These do not expire.
remainingintegerИә
is_unlimitedbooleanЖоқ
can_look_upbooleanИә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_standingbooleanЖоқ
packsobject[]ИәPacks of extra lookups available to buy.

Бұл соңғы нүкте қайтара алатын қателер

401 · 403 · 422