Vous pouvez générer le document de piste d’audit à tout moment au cours d’un flux de travail actif. Avec les API décrites dans cet article, vous pouvez inspecter les données et la progression d’une transaction chaque fois que nécessaire, par exemple en cas de comportement inattendu.
La génération d’une piste d’audit implique les étapes suivantes :
Générer une piste d’audit
L’API Générer une piste d’audit génère le document de piste d’audit. Une fois la génération de la piste d’audit terminée, une notification est envoyée. Le document généré peut ensuite être téléchargé (voir Télécharger le document de piste d’audit).
Syntaxe
POST /api/transactions/uuid: transaction_id/generate-audit-trailParamètres disponibles
Paramètres de la requête (génération d’une piste d’audit) | ||
Nom | Données de requête HTTP | Description |
|---|---|---|
Autorisation | En-tête de la demande | Obligatoire. Il s’agit du jeton d’autorisation. Format : Jeton porteur |
force | Paramètre de requête | Optionnel. Détermine comment la demande sera traitée si le document de piste d’audit a déjà été généré. Valeurs possibles :
Si le document demandé n’existe pas, la valeur force sera ignorée et le document sera généré. Valeur par défaut : false |
Exemples
Exemple de demande
La demande suivante n’inclut pas le paramètre force :
curl --location --request POST 'https://host:port/api/transactions/00178a9e-0862-4055-88b8-94f49618b51b/generate-audit-trail' \
--header 'Authorization: Bearer token' \
--header 'Cookie: cookie'La requête suivante inclut le paramètre force défini sur true :
curl --location --request POST 'https://host:port/api/transactions/00178a9e-0862-4055-88b8-94f49618b51b/generate-audit-trail?force=true' \
--header 'Authorization: Bearer token' \
--header 'Cookie: cookie'Exemple de réponse
La réponse contient le lien vers l’emplacement de téléchargement du document de piste d’audit. Le lien a le format suivant :
"sfs://shared_storage_id/tenant_id/transactions/transaction_id/docs/AuditTrailDocument_transaction_version_number_events/1"Exemple de réponse si un document de piste d’audit est généré :
{
"build_status": "in_progress",
"path": "sfs://my_db/default/dealflo/transactions/00178a9e-0862-4055-88b8-94f49618b51b/docs/AuditTrailDocument_11_40/1"
}Exemple de réponse si le document de piste d’audit existe déjà :
{
"build_status": "already_exist",
"path": "sfs://my_db/default/dealflo/transactions/00178a9e-0862-4055-88b8-94f49618b51b/docs/AuditTrailDocument_11_40/1"
}Notifications
La génération du document de piste d’audit est une opération chronophage. L’état est renvoyé dans le cadre de la réponse (voir Exemple de réponse). Si le statut est in_progress, le document est en cours de création et le lien SFS sera disponible dès que la génération du document sera terminée. Une notification indiquant que le document a été généré avec succès sera envoyée au point de terminaison du locataire.
La notification est envoyée lorsque le document demandé est disponible en téléchargement.
Si le document existe déjà avant l’envoi d’une demande de génération de piste d’audit, une notification sera envoyée dès que la demande sera terminée.
Si le document demandé n’existe pas avant l’envoi de la demande, une notification sera envoyée au point de terminaison avec un certain retard.
Contenu de l’événement de notification
Propriétés de l’événement de notification répertorie les propriétés incluses dans l’événement de notification envoyé au point de terminaison du locataire lorsque la génération de la piste d’audit est terminée.
| Propriété | Description |
|---|---|
| horodatage | L’horodatage actuel, requis pour NS MS. |
| type | Le type d’événement (notification). |
| transaction_id | UUID de la transaction à laquelle appartient l’événement. |
| gâchette | Le déclencheur d’événement. |
| skip_common_ux_components | Indique au back-end d’ignorer les composants UX courants du flux de travail, tels que l’en-tête, le pied de page, l’erreur, etc., lors de la création de l’état d’affichage. Valeur par défaut : true Cette propriété est ignorée pour cet événement. |
| skip_view_state | Indique au back-end d’ignorer l’état d’affichage dans la réponse d’état de la transaction. Valeur par défaut : false Cette propriété est ignorée pour cet événement. |
| document_references | Liste des références de documents contenant les URL SFS à la demande de piste d’audit pour chaque document. |
| Message | Le message lisible par l’homme. |
| champs | Données d’événement supplémentaires. Cette liste ne contient que le callback_type, qui est ignoré pour cet événement. |
| Version | La version événementielle. Cette propriété est ignorée pour cet événement. |
Exemple de notification
{
"timestamp": "2022-01-05T09:16:15.005Z",
"type": "notification",
"transaction_id": "00178a9e-0862-4055-88b8-94f49618b51b",
"trigger": "callback_trigger",
"skip_common_ux_components": true,
"skip_view_state": false,
"document_references": ["sfs://my_db/default/dealflo/transactions/00178a9e-0862-4055-88b8-94f49618b51b/docs/AuditTrailDocument_11_40/1"],
"message": "An Audit trail has been successfully created.",
"fields": [
{
"name": "callback_type",
"value": "active"
}
],
"version": 0
}Télécharger le document de piste d’audit
L’API Télécharger le document de piste d’audit télécharge le document de piste d’audit généré à l’aide de l’option Générer une piste d’audit. La réponse de la demande generate-audit-trail contient le lien vers l’emplacement de téléchargement du document. Ce lien est inclus dans la demande de téléchargement du document de piste d’audit.
Syntaxe
GET /api/transactions/uuid:transaction_id/dataParamètres disponibles
Paramètres de la requête (télécharger le document de piste d’audit) | ||
Nom | Données de requête HTTP | Description |
|---|---|---|
Autorisation | En-tête de la demande | Obligatoire. Il s’agit du jeton d’autorisation. Format : Jeton porteur |
URL | Paramètre de requête | Obligatoire. Le lien vers l’emplacement de téléchargement du document de piste d’audit. Format : sfs:// shared_storage_id/tenant_id/transactions/uuid :transaction_id/docs/AuditTrailDocument_transaction_version_number_events/1 |
Exemples
Exemple de demande
curl --location --request GET 'https://host:port/api/transactions/00178a9e-0862-4055-88b8-94f49618b51b/data?url=sfs://my_db/default/dealflo/transactions/00178a9e-0862-4055-88b8-94f49618b51b/docs/AuditTrailDocument_11_40/1' \
--header 'Authorization: Bearer token' \
--header 'Cookie: cookie'