POST /v1/webhooks/test
Pošle na cíl webhooků vašeho partnerského účtu zkušební událost ping a vrátí výsledek jejího jediného pokusu.
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
Endpoint nemá parametry dotazu.
Odpověď
200 · application/json · WebhookDeliveryResponseUdálost je podepsaná jako každá jiná a její data jsou prázdný objekt; ověříte si tak, že váš cíl kontroluje podpis.
Status delivered znamená odpověď 2xx, exhausted jakoukoli jinou odpověď; stav HTTP najdete v lastStatusCode. Zkušební událost se neopakuje.
Bez nastaveného cíle vrací 409 WEBHOOK_NOT_CONFIGURED. Cíl a výběr událostí nastaví Coinero podle vašeho zadání, tajemství vygeneruje Coinero; API je nemění. Požadavek nemá tělo.
Nejvýš 5 zkušebních událostí za minutu na klíč, nad tím 429 RATE_LIMIT_EXCEEDED.
Vyžaduje partnerský API klíč s oprávněním subaccounts a podepsaný požadavek. Odpověď se neukládá do cache.
| Pole | Popis |
|---|---|
| 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. |
| typestring | Typ události, například order.filled nebo ping. |
| attemptinteger (int32) | Počet dosud provedených pokusů o doručení. |
| statusstring | Stav doručení. Hodnoty: pending, delivered, exhausted, skipped. |
| 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. |
| 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. |
| nextAttemptAtMsinteger nebo null | Stejný okamžik jako Unix timestamp v milisekundách. Nebo null. Pole je v odpovědi vždy. |
| createdAtstring | Kdy událost nastala, ISO 8601 v UTC. |
| createdAtMsinteger (int64) | Stejný okamžik jako Unix timestamp v milisekundách. |
| 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. |
| deliveredAtMsinteger nebo null | Stejný okamžik jako Unix timestamp v milisekundách. Nebo null. Pole je v odpovědi vždy. |
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í |
|---|---|---|
| 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. |
| 409 | WEBHOOK_NOT_CONFIGURED | Požádejte svůj kontakt v Coineru o nastavení cíle webhooků (adresa HTTPS a výběr událostí); tajemství podpisu dostanete od něj. Do té doby sledujte stav pokynů přes GET /v1/subaccounts/orders. |
| 429 | RATE_LIMIT_EXCEEDED | Před dalším pokusem vyčkejte počet sekund z Retry-After. |