Obtenir les paramètres du webhook (ceux de l’opérateur, ou, avec la clé d’administration d’un client, ceux de ce client)
- Dans le bac à sable
En termes simples
Depuis la 0.16.0, la clé de l’opérateur lit les paramètres d’un client avec client. La clé d’administration d’un client ne peut nommer que
son propre client ; tout autre répond 404. Un paramètre inconnu ou répété, ou client vide, répond 400.
Définir et tester un webhook n’acceptent aucun paramètre de requête (400) : ils restent liés à la clé propre du webhook.
apiKeyAuthorizationBearer <token>Envoyez votre clé sous forme de jeton bearer : Authorization: Bearer <your-api-key>. L’état du service est le seul appel qui ne nécessite pas de clé.
client?stringLe client choisi par l’opérateur. Une autre forme répond 400.
^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$Paramètres actuels. Le secret n’est jamais renvoyé. Sans rien de défini, url est null et active est false.
application/json- response
url*|^https://uriactive*booleansecret_rotated_at?|date-timecontact_email?|Qui prévenir quand les livraisons échouent définitivement.
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 }}Construire et contrôler un document sans l’envoyer POST
Exécute le schéma, les pré-contrôles, le sérialiseur du canal et chaque couche de validation officielle, puis renvoie le rapport et les documents construits, chacun avec ses octets dans content_base64 quand il fait 2 Mio ou moins. Rien n’est envoyé et rien n’est stocké en dehors du journal des requêtes. Servez-vous-en lors du mapping d’un nouveau client. Un nombre hors des limites (voir les conventions) répond 422 avant tout contrôle.
Définir l’URL du webhook, ou renouveler son secret PUT
La clé de l’opérateur définit le webhook de l’opérateur, qui reçoit les événements de tous les clients ; la clé d’administration d’un client définit celui de ce client, qui ne reçoit que ses événements. Le premier appel exige url et crée le secret, renvoyé une seule fois. Le renouvellement renvoie le nouveau secret une seule fois. Pendant 24 heures, le service signe chaque livraison avec le nouveau et l’ancien secret, afin que le partenaire puisse basculer sans perdre d’événements. Seuls les événements écrits après le premier appel sont livrés. L’URL doit être en https, et chaque adresse que son hôte résout doit être publique : les adresses de bouclage, privées, link-local, CGNAT, multicast, réservées et de métadonnées cloud sont refusées, ici et de nouveau avant chaque livraison. Les redirections ne sont pas suivies. Depuis la 0.16.0, tout paramètre de requête répond 400, de sorte qu’un client mal orthographié ne peut jamais modifier le webhook de l’opérateur.