Mises à jour de statut et points de rappel (callbacks)
Pour recevoir et traiter des mises à jour en temps réel et des informations sur le statut de vos documents envoyés, vous pouvez utiliser un mécanisme de "callbacks" en plus des appels API habituels.
Voici comment fonctionnent les crochets :
- Informations sur le statut en temps réel : Nos points de rappel réagissent automatiquement aux changements de statut de vos documents. Cela vous permet de recevoir des mises à jour en temps réel sur l'état d'avancement de vos envois.
- Actions personnalisables : Vous pouvez utiliser les points de rappel pour personnaliser les statuts des envois dans votre système ou pour effectuer des actions spécifiques sur des statuts d'envois spécifiques.
- Pas besoin de sonder : Les points de rappel vous évitent d'avoir à interroger le statut d'un envoi à chaque fois, ce qui réduit le nombre d'appels à l'API.
Les points de rappel peuvent être gérés par le biais des configurations /api/callback.
Un rappel sera toujours un POST HTTP sur votre point de terminaison configuré.
Le corps d'un tel rappel ressemblera à ceci :
{
"EventName" = " DocumentStatusUpdated",
"OccuredAtUtc" = "DateTime.UtcNow",
"Properties" = [
{
"Key" = "NewStatus",
"Value" = "StatusEnumValue"
},
{
"Key" = "DocumentReference",
"Value" = "documentReference"
},
{
"Key" = "ExternalId",
"Value" = "documentExternalId"
}
]
}
EventName: Ce sera toujours "DocumentStatusUpdated".
DocumentReference : La référence du document telle que vous l'avez fournie lors du téléchargement du document. Lors du téléchargement, ce champ est facultatif. Si vous ne l'avez pas fourni lors du téléchargement, cette propriété ne sera pas fournie.
ExternalId : L'identifiant unique d'un document dans Postbird. Cet identifiant est renvoyé lors du téléchargement du document.
StatusEnumValue : Contient le nouveau statut du document. Les valeurs possibles sont :
UploadAwaiting = 0, // Le document a été téléchargé dans notre système et attend d'être traité.
UploadError = 1, // Un problème s'est produit lors du téléchargement dans notre système.
UploadOk = 2, // Le document a été correctement téléchargé et est prêt à être traité.
PdfCriticalValidationAwaiting = 3, // Postbird a commencé à valider le document PDF
PdfCriticalValidationError = 4, // Le document n'est pas un PDF valide ou la taille du papier n'est pas valide (pas A4)
PdfCriticalValidationOk = 5, // Postbird a terminé avec succès la validation du document PDF
AddressAwaiting = 6, // Postbird commence la validation de l'adresse
AddressError = 7, // L'adresse n'a pas de structure valide ou n'a pas été trouvée
AddressOk = 8, // L'adresse est correcte
PaymentAwaiting = 9, // Postbird a commencé le paiement du document
PaymentError = 10, // Un problème est survenu lors du paiement du document (solde insuffisant)
PaymentOk = 11, // Le document a été payé
SentToNotificationService = 12, // Le document a été envoyé au centre d'impression
SentToNotificationServiceError = 13, // Un problème est survenu lors de l'envoi du document au centre d'impression
AwaitingPrint = 14, // Le document est en attente d'impression au centre d'impression
Printed = 15, // Le document a été imprimé
Send = 16, // Le document a été remis à l'opérateur postal
NotDelivered = 17, // Le document n'a pas été remis au destinataire (mauvaise adresse, déménagement, ...)
NormalSendingFailed = 18, // L'opérateur postal n'a pas pu envoyer le document au destinataire.
En savoir plus : Enum