GET /v1/webhooks/deliveries
Vrací doručení událostí webhooků vašeho partnerského účtu od nejnovějšího po stránkách s kurzorem, abyste mohli ladit svůj cíl.
Partnerský klíč s oprávněním subaccounts
pk_) s oprávněním subaccounts a podpis požadavku; klientský klíč dostane 403 INSUFFICIENT_PERMISSION. Postup je na stránkách Podpis požadavků a Klíč partnera.Parametry dotazu
| Parametr | Popis |
|---|---|
| sincevolitelnéstring | Jen události po tomto okamžiku (bez něj). ISO 8601 (chybějící posun znamená UTC) nebo milisekundy od počátku Unixové epochy. |
| statusvolitelnéstring | Jen doručení v tomto stavu: pending, delivered, exhausted nebo skipped. |
| limitvolitelnéstring | Počet doručení na stránce, od 1 do 500. Výchozí 50. |
| cursorvolitelnéstring | nextCursor předchozí stránky. Neprůhledná hodnota, pošlete ji beze změny. |
Odpověď
200 · application/json · WebhookDeliveryListResponsePoložka nese identifikátor a typ události, počet pokusů, stav, stav HTTP poslední odpovědi a termín dalšího pokusu; těla událostí odpověď nevrací.
Coinero posílá na váš cíl HTTPS požadavek POST s tělem { eventId, type, occurredAt, occurredAtMs, partnerCode, data }, kde data je týž objekt jako v odpovědi REST pokynu nebo subúčtu, u události report.daily.ready souhrn denního reportu, a s hlavičkami X-COINERO-EVENT-ID, X-COINERO-TIMESTAMP a X-COINERO-SIGNATURE (HMAC-SHA256 nad timestamp a tělem, klíčem jsou dekódované bajty tajemství webhooku z Base64, výsledek hex malými písmeny).
Odpovězte stavem 2xx do 10 s. Po jiné odpovědi, přesměrování nebo vypršení časového limitu se doručení opakuje po 1, 5, 15 a 60 minutách a pak každé 2 hodiny, nejdéle 24 hodin od události. Událost se doručí alespoň jednou: duplicity rozpoznáte podle eventId.
Po výpadku cíle dočtěte stav přes GET /v1/subaccounts/orders s updatedAfter.
Vyžaduje partnerský API klíč s oprávněním subaccounts a podepsaný požadavek. Odpověď se neukládá do cache.
| Pole | Popis |
|---|---|
| itemspole WebhookDeliveryResponse | Doručení událostí webhooků vašeho partnerského účtu od nejnovějšího. |
| items[].eventIdstring | Identifikátor události, tatáž hodnota jako eventId v těle a v hlavičce X-COINERO-EVENT-ID. Podle něj rozpoznáte duplicity: událost může dorazit víckrát. |
| items[].typestring | Typ události, například order.filled nebo ping. |
| items[].attemptinteger (int32) | Počet dosud provedených pokusů o doručení. |
| items[].statusstring | Stav doručení. Hodnoty: pending, delivered, exhausted, skipped. |
| items[].lastStatusCodeinteger nebo null | Stav HTTP, kterým váš cíl odpověděl na poslední pokus, nebo null, když odpověď nepřišla (časový limit, chyba spojení) nebo ještě neproběhl žádný pokus. Pole je v odpovědi vždy. |
| items[].nextAttemptAtstring nebo null | Kdy je na řadě další pokus, ISO 8601 v UTC, nebo null, když už žádný nebude. Pole je v odpovědi vždy. |
| items[].nextAttemptAtMsinteger nebo null | Stejný okamžik jako Unix timestamp v milisekundách. Nebo null. Pole je v odpovědi vždy. |
| items[].createdAtstring | Kdy událost nastala, ISO 8601 v UTC. |
| items[].createdAtMsinteger (int64) | Stejný okamžik jako Unix timestamp v milisekundách. |
| items[].deliveredAtstring nebo null | Kdy váš cíl odpověděl stavem 2xx, ISO 8601 v UTC, nebo null. Pole je v odpovědi vždy. |
| items[].deliveredAtMsinteger nebo null | Stejný okamžik jako Unix timestamp v milisekundách. Nebo null. Pole je v odpovědi vždy. |
| nextCursorstring nebo null | Neprůhledný kurzor další stránky, pošlete ho v parametru cursor. Null, když starší doručení nenásledují. Pole je v odpovědi vždy. |
| hasMoreboolean | True, když dotazu odpovídají další, starší doručení za touto stránkou. |
| limitinteger (int32) | Nejvyšší počet doručení na stránce, jak byl požadován. |
Hodnoty stavů
Nové hodnoty mohou přibýt i v rámci v1; neznámou hodnotu zpracujte bez selhání.
| PublicWebhookDeliveryStatus | Význam |
|---|---|
pending | doručení čeká na první nebo další pokus (viz nextAttemptAt) |
delivered | váš cíl odpověděl stavem 2xx |
exhausted | do 24 hodin od události neuspěl žádný pokus (u zkušební události selhal její jediný pokus) a další pokus už nebude |
skipped | událost se neodeslala, protože cíl webhooků byl zrušen |
Chyby
Chyby mají formát application/problem+json; zpracovávejte je podle pole code. Podrobnosti najdete v přehledu chyb.
| Stav | Kódy | Řešení |
|---|---|---|
| 400 | INVALID_PARAMETER | Opravte parametry uvedené v poli detail podle dokumentace. Opakovaný parametr se bere jako chybný. |
| 401 | MISSING_API_KEY, INVALID_API_KEY, SIGNATURE_REQUIRED, INVALID_SIGNATURE, TIMESTAMP_OUT_OF_WINDOW | Doplňte hlavičku X-COINERO-APIKEY. Ověřte hodnotu a stav klíče i aktivitu účtu. Doplňte hlavičky X-COINERO-TIMESTAMP a X-COINERO-SIGNATURE podle stránky Podpis požadavků. Zkontrolujte kanonický řetězec (časová značka, metoda velkými písmeny, cesta s dotazem, tělo bajt po bajtu) a že secret před HMAC dekódujete z Base64; stránka Podpis požadavků má referenční vektor. Použijte aktuální čas v milisekundách; pole serverTime a serverTimeMs v odpovědi nesou čas serveru, podle kterého opravte hodiny klienta. |
| 403 | INSUFFICIENT_PERMISSION, IP_NOT_ALLOWED | Pole requiredPermission uvádí, které oprávnění chybí. Oprávnění klíče nelze změnit; vytvořte nový klíč s potřebným oprávněním. Odešlete požadavek z adresy povolené u klíče, nebo vytvořte nový klíč, jehož seznam adresu obsahuje; seznam nelze dodatečně změnit. |
| 405 | METHOD_NOT_ALLOWED | Použijte metodu z hlavičky Allow: GET a HEAD ke čtení, POST a DELETE jen u operací, které je mají v dokumentaci. |
| 429 | RATE_LIMIT_EXCEEDED | Před dalším pokusem vyčkejte počet sekund z Retry-After. |