Leggere le impostazioni del webhook (quelle dell’operatore, oppure, con la chiave admin di un cliente, quelle del cliente stesso)
- Nella sandbox
In parole semplici
Dalla 0.16.0 la chiave dell’operatore legge le impostazioni di un cliente con client. La chiave admin di un cliente può indicare solo
il proprio cliente; ogni altro risponde 404. Un parametro sconosciuto o ripetuto, o client vuoto, risponde 400.
Impostare e provare un webhook non accettano alcun parametro di query (400): restano legati alla chiave del webhook.
apiKeyAuthorizationBearer <token>Inviare la chiave come token bearer: Authorization: Bearer <your-api-key>. Lo stato del servizio è l’unica chiamata che non richiede una chiave.
client?stringIl cliente scelto dall’operatore. Un’altra forma risponde 400.
^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$Impostazioni attuali. Il segreto non viene mai restituito. Se non c’è nulla di impostato, url è null e active è false.
application/json- response
url*|^https://uriactive*booleansecret_rotated_at?|date-timecontact_email?|Chi avvisare quando le consegne si interrompono.
last_delivery?|nullcurl -X GET "https://example.com/webhook" \ -H "Authorization: Bearer <your-api-key>"{ "url": "http://example.com", "active": true, "secret_rotated_at": "2019-08-24T14:15:22Z", "contact_email": "string", "last_delivery": { "at": "2019-08-24T14:15:22Z", "http_status": 0 }}Costruire e controllare un documento senza inviarlo POST
Esegue lo schema, i controlli preliminari, il serializzatore del canale e ogni livello di validazione ufficiale, poi restituisce il rapporto e i documenti generati, ciascuno con i suoi byte in content_base64 quando è di 2 MiB o meno. Non viene inviato nulla e non viene conservato nulla oltre al registro delle richieste. Utile durante la mappatura di un nuovo cliente. Un numero oltre i limiti (vedere le convenzioni) risponde 422 prima di qualsiasi controllo.
Impostare l’URL del webhook, oppure cambiarne il segreto PUT
La chiave dell’operatore imposta il webhook dell’operatore, che riceve gli eventi di ogni cliente; la chiave admin di un cliente imposta quello del cliente stesso, che riceve solo i suoi eventi. La prima chiamata richiede url e crea il segreto, che viene restituito una sola volta. Il cambio restituisce il nuovo segreto una sola volta. Per 24 ore il servizio firma ogni consegna sia con il nuovo sia con il vecchio segreto, così il partner può passare all’altro senza perdere eventi. Vengono consegnati solo gli eventi scritti dopo la prima chiamata. L’URL deve essere https e ogni indirizzo a cui il suo host risolve deve essere pubblico: loopback, privato, link-local, CGNAT, multicast, riservato e indirizzi dei metadati cloud vengono rifiutati, qui e di nuovo prima di ogni consegna. I reindirizzamenti non vengono seguiti. Dalla 0.16.0 qualsiasi parametro di query risponde 400, così un client scritto male non può mai cambiare il webhook dell’operatore.