Récupération d'une liste de transactions

Il est fortement recommandé d'utiliser un écouteur de rappel (Callback Listener) au lieu d'interroger les statuts de transaction. L'utilisation de l'interrogation peut consommer des ressources inutiles tant de votre côté que du côté du service OneSpan Sign.

Récupération des transactions dans les plages de dates spécifiées

Pour télécharger l'exemple complet de code, consultez notre site Partage de code.

La première étape de la récupération d'une liste de transactions comprises dans une plage de dates spécifiée consiste à définir cette plage de dates. Le code suivant permet d'effectuer ce qui suit :

Date START_DATE = new LocalDateTime(2016, 1, 1, 0, 0).toDate(); //January 01 2016, 00:00 EST
Date END_DATE = LocalDateTime.now().toDate();

Ensuite, vous pouvez retrouver vos transactions dans cette plage de dates, triées par statut. Par exemple, COMPLÉTÉ, ÉBAUCHE, ARCHIVÉ, ENVOYÉ et DÉCLINÉ). Le code suivant permet d'effectuer ce qui suit :

Page<DocumentPackage> draftPage = eslClient.getPackageService().getUpdatedPackagesWithinDateRange(PackageStatus.DRAFT, new PageRequest(1), START_DATE, END_DATE);

Récupération d'une liste d'ID de transactions

Pour télécharger l'exemple complet de code, consultez notre site Partage de code.

La récupération d'une liste d'identifiants de transaction renvoie un objet Page contenant une liste de types de mappages, chaque type de mappage contenant l'PackageID.

Le code suivant permet d'effectuer ce qui suit :

		PageRequest pageRequest = new PageRequest(1, 100);
		Boolean hasNext = false;
		do {
		    Page<Map<String, String>> packages = eslClient.getPackageService().getPackagesFields(PackageStatus.COMPLETED,
		            pageRequest, Sets.newHashSet("id"));
		    hasNext = packages.hasNextPage();
		    pageRequest = pageRequest.next();
		     
		    List<Map<String,String>> results = packages.getResults();
		    for (Map<String, String> map : results) {
		        String packageId = map.get("id");
		        System.out.println(packageId);
		    }
		     
		} while (hasNext);

Récupération des transactions dans les plages de dates spécifiées

Pour télécharger l'exemple complet de code, consultez notre site Partage de code.

DateTime START_DATE = DateTime.Now.AddDays(-100); //Retrieve packages for last 100 days
DateTime END_DATE = DateTime.Now;

Page<DocumentPackage> draftPage = eslClient.PackageService.GetUpdatedPackagesWithinDateRange(DocumentPackageStatus.DRAFT, new PageRequest(1), START_DATE, END_DATE);

Récupération d'une liste d'ID de transactions

Pour télécharger l'exemple complet de code, consultez notre site Partage de code.

La récupération d'une liste d'identifiants de transaction renvoie un objet Page contenant une liste de types de mappages, chaque type de mappage contenant l'PackageID.

Le code suivant permet d'effectuer ce qui suit :

            PageRequest pageRequest = new PageRequest(1, 100);
            bool hasNext = false;
            do
            {
                Page<Dictionary<String, String>> packages = eslClient.PackageService.GetPackagesFields(DocumentPackageStatus.COMPLETED,
                        pageRequest, new HashSet<String>() { "id" });
                hasNext = packages.HasNextPage();
                pageRequest = pageRequest.Next;
                IList<Dictionary<String, String>> results = packages.Results;
                foreach (var map in results)
                {
                    String packageId = map["id"];
                    Debug.WriteLine(packageId);
                }
            } while (hasNext);

Récupération des transactions dans les plages de dates spécifiées

Pour télécharger l'exemple complet de code, consultez notre site Partage de code.

Requête HTTP

GET /api/packages?query={status}&from={from}&to={to}&lastUpdatedStartDate={lastUpdatedStartDate}&lastUpdatedEndDate={lastUpdatedEndDate}

En-têtes HTTP

Accept: application/json
Content-Type: application/json
Authorization: Basic api_key

Les objets JSON de chaque transaction vous seront renvoyés. Voici les valeurs possibles pour chaque paramètre :

Données utiles de la réponse

{
  "results": [
  		{
  		    "id": "mC3p1FENigGItiL3Zmojtr64e0Y=",
		    "status": "DRAFT",
		    "description": "",
		    "language": "en",
		    ...
  		},
  		{...},
  		{...},
  		...
   ],
  "count": 216
}

query : ARCHIVÉ, COMPLÉTÉ, ÉBAUCHE, ENVOYÉ, EXPIRÉ, REFUSÉ, et DÉCLINÉ.
from : Utilisé pour la pagination.
to : Utilisé pour la pagination. (Remarque : Un maximum de 100 transactions peut être retourné)
lastUpdatedStartDate : La date après laquelle la dernière transaction mise à jour doit être récupérée (par exemple, 2021-01-01).
lastUpdatedEndDate : La date avant laquelle la dernière transaction mise à jour doit être récupérée (par exemple, 2021-12-31).

Récupération d'une liste d'ID de transactions

Le code suivant permet de le faire. Notez ce qui suit :

champs : La seule valeur disponible est « id ».

Requête HTTP

GET /api/packages?query={status}&from={from}&to={to}&lastUpdatedStartDate={lastUpdatedStartDate}&lastUpdatedEndDate={lastUpdatedEndDate}&fields=id

En-têtes HTTP

Accept: application/json
Content-Type: application/json
Authorization: Basic api_key

Données utiles de la réponse

{
    "results": [
        {
            "id": "uchWJej65gbJsVaWmibQHGc8_rA="
        },
        {
            "id": "jUfE05dJsa6d3A_oYxixt0gf2SI="
        },
        ...
    ],
    "count": 216
}

Pour télécharger l'exemple complet de code, consultez notre site Partage de code.