Java SDK .NET SDK REST API APEX SDK
Java SDK
Pour télécharger l’exemple de code complet, consultez notre site Code Share .
Une fois qu’une transaction a été créée, vous pouvez récupérer le statut de signature de cette transaction ou d’un signataire particulier.
Il est fortement recommandé d’utiliser un Callback Listener au lieu d’interroger les statuts des transactions. L’utilisation de l’interrogation peut consommer des ressources inutiles de votre côté et du service OneSpan Sign.
Les transactions OneSpan Sign suivent un cycle de vie prédéfini, défini par les états de cycle de vie suivants :
Brouillon : La transaction n’a pas encore été envoyée, elle est inactive et peut être modifiée. Le statut de signature « INACTIF » sera renvoyé.
En cours : La transaction a été distribuée pour signatures, mais n’est pas encore terminée. Un statut de signature de « SIGNING_PENDING » ou « SIGNING_COMPLETE » sera renvoyé, en fonction de la progression du signataire.
Terminée : La transaction a été signée par tous les destinataires. Le statut de signature « TERMINÉ » sera renvoyé
Désabonnement : Au moins un destinataire de la transaction a choisi de ne pas signer la transaction par voie électronique. Remarque : L’option de désinscription a été supprimée de l’expérience du signataire.
Refusée : la transaction a au moins un destinataire qui a refusé de signer la transaction. Le statut de signature « REFUSÉ » sera retourné.
Expirée : La transaction a expiré (c’est-à-dire que sa date d’expiration est passée). L’état de signature « EXPIRÉ » sera renvoyé.
Archivé : La transaction a été archivée. L’état de signature « ARCHIVÉ » sera retourné.
Le diagramme suivant décrit le flux normal d’une transaction. En outre, ce diagramme comprend deux actions possibles que vous pouvez effectuer au cours de ce processus de cycle de vie.
Action Corbeille : L’action Corbeille est utilisée pour déplacer une transaction sélectionnée vers le dossier Corbeille . Le statut de signature « SUPPRIMÉ » sera renvoyé. Les transactions dans le dossier corbeille ne sont pas automatiquement supprimées, sauf si une politique de rétention spécifique est définie pour ce compte. Les transactions qui sont supprimées manuellement de ce dossier sont récupérables pendant deux semaines après la suppression. Pour récupérer ces transactions, vous devez contacter notre équipe d’assistance.
Action de suppression : votre package sera définitivement supprimé et ne pourra pas être rétabli. Le statut de signature « SUPPRIMÉ » sera renvoyé.
La première étape consiste à créer votre objet PackageId . Pour ce faire, le code suivant :
PackageId packageId = new PackageId("XB4m3cocNudSPEAoUDCIZgbkZD4=");
Ensuite, vous utilisez le client OneSpan Sign pour interroger l’état de la transaction et d’un signataire. Pour ce faire, le code suivant :
com.silanis.esl.sdk.SigningStatus pkgStatus =
eslClient.getSigningStatus(packageId, null, null);
com.silanis.esl.sdk.SigningStatus signerStatus1 =
eslClient.getSigningStatus(packageId, new SignerId(signerId1), null);
Résultats
Une fois que vous avez récupéré l’état de signature, faites un System.out.println() de chaque objet SigningStatus .
Voici un exemple de ce que vous pouvez vous attendre à voir une fois que vous avez exécuté votre code.
Kit de développement logiciel (SDK) .NET
Pour télécharger l’exemple de code complet, consultez notre site Code Share .
Une fois qu’une transaction a été créée, vous pouvez récupérer le statut de signature de cette transaction ou d’un signataire particulier.
Il est fortement recommandé d’utiliser un Callback Listener au lieu d’interroger les statuts des transactions. L’utilisation de l’interrogation peut consommer des ressources inutiles de votre côté et du service OneSpan Sign.
Les transactions OneSpan Sign suivent un cycle de vie prédéfini, défini par les états de cycle de vie suivants :
Brouillon : La transaction n’a pas encore été envoyée, elle est inactive et peut être modifiée. Le statut de signature « INACTIF » sera renvoyé.
En cours : La transaction a été distribuée pour signatures, mais n’est pas encore terminée. Un statut de signature de « SIGNING_PENDING » ou « SIGNING_COMPLETE » sera renvoyé, en fonction de la progression du signataire.
Terminée : La transaction a été signée par tous les destinataires. Le statut de signature « TERMINÉ » sera renvoyé
Désabonnement : Au moins un destinataire de la transaction a choisi de ne pas signer la transaction par voie électronique. Remarque : L’option de désinscription a été supprimée de l’expérience du signataire.
Refusée : la transaction a au moins un destinataire qui a refusé de signer la transaction. Le statut de signature « REFUSÉ » sera retourné.
Expirée : La transaction a expiré (c’est-à-dire que sa date d’expiration est passée). L’état de signature « EXPIRÉ » sera renvoyé.
Archivé : La transaction a été archivée. L’état de signature « ARCHIVÉ » sera retourné.
Le diagramme suivant décrit le flux normal d’une transaction. En outre, ce diagramme comprend deux actions possibles que vous pouvez effectuer au cours de ce processus de cycle de vie.
Action Corbeille : L’action Corbeille est utilisée pour déplacer une transaction sélectionnée vers le dossier Corbeille . Le statut de signature « SUPPRIMÉ » sera renvoyé. Les transactions dans le dossier corbeille ne sont pas automatiquement supprimées, sauf si une politique de rétention spécifique est définie pour ce compte. Les transactions qui sont supprimées manuellement de ce dossier sont récupérables pendant deux semaines après la suppression. Pour récupérer ces transactions, vous devez contacter notre équipe d’assistance.
Action de suppression : votre package sera définitivement supprimé et ne pourra pas être rétabli. Le statut de signature « SUPPRIMÉ » sera renvoyé.
La première étape consiste à créer votre objet PackageId . Pour ce faire, le code suivant :
PackageId packageId = new PackageId("XB4m3cocNudSPEAoUDCIZgbkZD4=");
Ensuite, vous utilisez le client OneSpan Sign pour interroger l’état de la transaction et d’un signataire. Pour ce faire, le code suivant :
Silanis.ESL.SDK.SigningStatus signerStatus1 =
eslClient.GetSigningStatus(packageId, signerId1, null);
Silanis.ESL.SDK.SigningStatus pkgStatus =
eslClient.GetSigningStatus(packageId, null, null);
Résultats
Une fois que vous avez récupéré l’état de signature, faites un Debug.WriteLine() de chaque objet SigningStatus .
Voici un exemple de ce que vous pouvez vous attendre à voir une fois que vous avez exécuté votre code.
REST API
Pour télécharger l’exemple de code complet, consultez notre site Code Share .
Une fois qu’une transaction a été créée, vous pouvez récupérer le statut de signature de cette transaction ou d’un signataire particulier.
Il est fortement recommandé d’utiliser un Callback Listener au lieu d’interroger les statuts des transactions. L’utilisation de l’interrogation peut consommer des ressources inutiles de votre côté et du service OneSpan Sign.
Les transactions OneSpan Sign suivent un cycle de vie prédéfini, défini par les états de cycle de vie suivants :
Brouillon : La transaction n’a pas encore été envoyée, elle est inactive et peut être modifiée.
En cours : La transaction a été distribuée pour signatures, mais n’est pas encore terminée.
Terminée : La transaction a été signée par tous les destinataires.
Désabonnement : Au moins un destinataire de la transaction a choisi de ne pas signer la transaction par voie électronique. Remarque : L’option de désinscription a été supprimée de l’expérience du signataire.
Refusée : la transaction a au moins un destinataire qui a refusé de signer la transaction.
Expirée : La transaction a expiré (c’est-à-dire que sa date d’expiration est passée).
Archivé : La transaction a été archivée.
Le diagramme suivant décrit le flux normal d’une transaction. En outre, ce diagramme comprend deux actions possibles que vous pouvez effectuer au cours de ce processus de cycle de vie.
Action Corbeille : L’action Corbeille est utilisée pour déplacer une transaction sélectionnée vers le dossier Corbeille . Les transactions dans le dossier corbeille ne sont pas automatiquement supprimées, sauf si une politique de rétention spécifique est définie pour ce compte. Les transactions qui sont supprimées manuellement de ce dossier sont récupérables pendant deux semaines après la suppression. Pour récupérer ces transactions, vous devez contacter notre équipe d’assistance.
Action de suppression : votre package sera définitivement supprimé et ne pourra pas être rétabli.
Le diagramme suivant décrit le flux normal d’une transaction. En outre, ce diagramme comprend deux actions possibles que vous pouvez effectuer au cours de ce processus de cycle de vie.
Action Corbeille : L’action Corbeille est utilisée pour déplacer une transaction sélectionnée vers le dossier Corbeille . Les transactions dans le dossier corbeille ne sont pas automatiquement supprimées, sauf si une politique de rétention spécifique est définie pour ce compte. Les transactions qui sont supprimées manuellement de ce dossier sont récupérables pendant deux semaines après la suppression. Pour récupérer ces transactions, vous devez contacter notre équipe d’assistance.
Action de suppression : votre package sera définitivement supprimé et ne pourra pas être rétabli.
Pour ce faire, le code suivant :
Requête HTTP
GET /api/packages/{packageId}/signingStatus?signer={signerId}&document={documentId}
En-têtes HTTP
Accept: application/json
Content-Type: application/json
Authorization: Basic api_key
Pour une description complète de chaque champ, consultez le tableau Charge utile de la demande ci-dessous.
Charge utile de réponse
{ "status": "DRAFT" }
Où le packageId vous est renvoyé lors de la création de la transaction. Si vous le souhaitez, vous pouvez ajouter les paramètres signerId et documentId pour récupérer l’état de signature d’un signataire ou d’un document.
Résultats
Les statuts de signature suivants sont disponibles :
INACTIF : la transaction est à l’état BROUILLON
SIGNING_PENDING : la transaction est dans un état SENT actif et le signataire n’a pas terminé ses signatures
SIGNING_COMPLETE : Le signataire désigné a terminé sa partie de la cérémonie de signature
APEX SDK
Pour télécharger l’exemple de code complet, consultez notre site Code Share .
Une fois qu’une transaction a été créée, vous pouvez récupérer le statut de signature de cette transaction ou d’un signataire particulier.
Il est fortement recommandé d’utiliser un Callback Listener au lieu d’interroger les statuts des transactions. L’utilisation de l’interrogation peut consommer des ressources inutiles de votre côté et du service OneSpan Sign.
Les transactions OneSpan Sign suivent un cycle de vie prédéfini, défini par les états de cycle de vie suivants :
Brouillon : La transaction n’a pas encore été envoyée, elle est inactive et peut être modifiée. Le statut de signature « INACTIF » sera renvoyé.
En cours : La transaction a été distribuée pour signatures, mais n’est pas encore terminée. Un statut de signature de « SIGNING_PENDING » ou « SIGNING_COMPLETE » sera renvoyé, en fonction de la progression du signataire.
Terminée : La transaction a été signée par tous les destinataires. Le statut de signature « TERMINÉ » sera renvoyé
Désabonnement : Au moins un destinataire de la transaction a choisi de ne pas signer la transaction par voie électronique. Remarque : L’option de désinscription a été supprimée de l’expérience du signataire.
Refusée : la transaction a au moins un destinataire qui a refusé de signer la transaction. Le statut de signature « REFUSÉ » sera retourné.
Expirée : La transaction a expiré (c’est-à-dire que sa date d’expiration est passée). L’état de signature « EXPIRÉ » sera renvoyé.
Archivé : La transaction a été archivée. L’état de signature « ARCHIVÉ » sera retourné.
Le diagramme suivant décrit le flux normal d’une transaction. En outre, ce diagramme comprend deux actions possibles que vous pouvez effectuer au cours de ce processus de cycle de vie.
Action Corbeille : L’action Corbeille est utilisée pour déplacer une transaction sélectionnée vers le dossier Corbeille . Le statut de signature « SUPPRIMÉ » sera renvoyé. Les transactions dans le dossier corbeille ne sont pas automatiquement supprimées, sauf si une politique de rétention spécifique est définie pour ce compte. Les transactions qui sont supprimées manuellement de ce dossier sont récupérables pendant deux semaines après la suppression. Pour récupérer ces transactions, vous devez contacter notre équipe d’assistance.
Action de suppression : votre package sera définitivement supprimé et ne pourra pas être rétabli. Le statut de signature « SUPPRIMÉ » sera renvoyé.
Le diagramme suivant décrit le flux normal d’une transaction. En outre, ce diagramme comprend deux actions possibles que vous pouvez effectuer au cours de ce processus de cycle de vie.
Action Corbeille : L’action Corbeille est utilisée pour déplacer une transaction sélectionnée vers le dossier Corbeille . Les transactions dans le dossier corbeille ne sont pas automatiquement supprimées, sauf si une politique de rétention spécifique est définie pour ce compte. Les transactions qui sont supprimées manuellement de ce dossier sont récupérables pendant deux semaines après la suppression. Pour récupérer ces transactions, vous devez contacter notre équipe d’assistance.
Action de suppression : votre package sera définitivement supprimé et ne pourra pas être rétabli.
La fonction suivante vous permet d’interroger un statut :
public String getSigningStatus(String packageId, String signerId, String documentId)
Vous pouvez également interroger le statut d’un package ou d’un signataire ou d’un signataire avec un ID de document spécifique. Pour ce faire, le code suivant :
String pkgStatus = getSigningStatus('_AQlDyjbxVLphMfM0oPG5YuioTU=',null,null); String signer1Status = getSigningStatus('_AQlDyjbxVLphMfM0oPG5YuioTU=','signer1@example.com',null); String signer1Document1Status = getSigningStatus('_AQlDyjbxVLphMfM0oPG5YuioTU=','signer1@example.com','document1');
Résultats
Voici un exemple de ce que vous pouvez vous attendre à voir une fois que vous avez exécuté votre code.