Données de documents personnalisés

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

Les attributs de document sont des données personnalisées liées à un document dans une transaction, ou à toutes les données dans une transaction. Ces données ne sont pas interprétées par OneSpan Sign. En tant que tels, les utilisateurs de ces données sont libres de stocker et d'interpréter les données qu'ils souhaitent.

Les données personnalisées peuvent également être appliquées au niveau de la transaction. Pour obtenir plus d'informations, consultez Attributs du paquet.

L'exemple de code suivant illustre la manière la plus simple de créer un paquet avec des attributs de document personnalisés. Cet exemple illustre comment créer des attributs personnalisés avec les clés Department et Employee. Les données d'attributs personnalisés sont construites sous forme de mappage.

 DocumentPackage pkg = eslClient.getPackageService().getPackage(packageId);
Document doc = pkg.getDocument(DOCUMENT_NAME);
Map < String, Object > attributes = doc.getData();
for (Map.Entry < String, Object > entry: attributes.entrySet()) {
	System.out.println("Key : " + entry.getKey() + " Value : " + entry.getValue());
} 

Récupération de vos attributs

Pour récupérer ces attributs, utilisez le code suivant :

DocumentPackage pkg = eslClient.getPackageService().getPackage(packageId);
Document doc = pkg.getDocument(DOCUMENT_NAME);
Map<String, Object> attributes = doc.getData();
for (Map.Entry<String, Object> entry : attributes.entrySet())
 {   
  System.out.println("Key : " + entry.getKey() + " Value : " + entry.getValue());   
 } 

Résultats

Voici un exemple de ce que vous pouvez vous attendre à voir une fois que vous aurez exécuté votre code.

.NET SDK

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

Les attributs de document sont des données personnalisées liées à un document dans une transaction, ou à toutes les données dans une transaction. Ces données ne sont pas interprétées par OneSpan Sign. En tant que tels, les utilisateurs de ces données sont libres de stocker et d'interpréter les données qu'ils souhaitent.

Les données personnalisées peuvent également être appliquées au niveau de la transaction. Pour obtenir plus d'informations, consultez Attributs du paquet.

L'exemple de code suivant illustre la manière la plus simple de créer un paquet avec des attributs de document personnalisés. Cet exemple illustre comment créer des attributs personnalisés avec les clés Department et Employee. Les données d'attributs personnalisés sont construites sous forme de mappage.

DocumentPackage superDuperPackage = PackageBuilder
    .NewPackageNamed(PackageName)
    .DescribedAs("This is a package created using the OneSpan Sign SDK")
    .WithSigner(SignerBuilder
        .NewSignerWithEmail(email1)
        .WithCustomId("Client1")
        .WithFirstName("John")
        .WithLastName("Smith")
        .WithTitle("Managing Director")
        .WithCompany("Acme Inc."))
    .WithDocument(DocumentBuilder
        .NewDocumentNamed(DOCUMENT_NAME)
        .FromStream(fileStream1, DocumentType.PDF)
        .WithSignature(SignatureBuilder
            .SignatureFor(email1)
            .OnPage(0)
            .AtPosition(100, 100))
        .WithData(DocumentAttributesBuilder
            .NewDocumentAttributes()
            .AddAttribute("Department", "1806")
            .AddAttribute("Employee", "135526")))
    .Build();

Récupération de vos attributs

Pour récupérer ces attributs, utilisez le code suivant :

DocumentPackage pkg = eslClient.GetPackage(packageId);
Document doc = pkg.GetDocument("sample doc");
IDictionary < string, object > attributes = doc.Data;
foreach(var attribute in attributes) {
	Debug.WriteLine("Key : " + attribute.Key + " Value : " + attribute.Value);
}

Résultats

Voici un exemple de ce que vous pouvez vous attendre à voir une fois que vous aurez exécuté votre code.

API REST

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

Les attributs de document sont des données personnalisées liées à un document dans une transaction, ou à toutes les données dans une transaction. Ces données ne sont pas interprétées par OneSpan Sign. En tant que tels, les utilisateurs de ces données sont libres de stocker et d'interpréter les données qu'ils souhaitent.

Les données personnalisées peuvent également être appliquées au niveau de la transaction. Pour obtenir plus d'informations, consultez Attributs du paquet.

L'exemple de code suivant illustre la manière la plus simple de créer un paquet avec des attributs de document personnalisés. Cet exemple illustre comment créer des attributs personnalisés avec les clés Department et Employee. Les données d'attributs personnalisés sont construites sous forme de mappage.

Requête HTTP

POST /api/packages

En-têtes HTTP

Accept: application/json   
Content-Type: multipart/form-data   
Authorization: Basic api_key 

Données utiles de la demande

------WebKitFormBoundary1bNO60n7FqP5WO4t
Content-Disposition: form-data; name="file"; filename="testDocumentExtraction.pdf"
Content-Type: application/pdf

%PDF-1.5
%µµµµ
1 0 obj
<>>>
endobj....

------WebKitFormBoundary1bNO60n7FqP5WO4t
Content-Disposition: form-data; name="payload"

{
  "autocomplete": true,
  "documents": [
    {
      "approvals": [
        {
          "fields": [
            {
              "extract": false,
              "height": 50,
              "left": 100,
              "page": 0,
              "subtype": "FULLNAME",
              "top": 100,
              "type": "SIGNATURE",
              "width": 200
            }
          ],
          "role": "Client1"
        }
      ],
      "data": {
        "Department": "1806",
        "Employee": "135526"
      },
      "name": "sample doc"
    }
  ],
  "name": "Document Attributes Example",
  "roles": [
    {
      "id": "Client1",
      "name": "Client1",
      "signers": [
        {
          "company": "Acme Inc.",
          "email": "mail32@example.com",
          "firstName": "John",
          "id": "Client1",
          "lastName": "Smith",
          "title": "Managing Director"
        }
      ]
    }
  ],
  "trashed": false,
  "type": "PACKAGE",
  "visibility": "ACCOUNT"
}

------WebKitFormBoundary1bNO60n7FqP5WO4t--

Pour une description complète de chaque champ, voir le tableau des données utiles de la demande ci-dessous.

Données utiles de la réponse

 {   "id": "9sKhW-h-qS9m6Ho3zRv3n2a-rkI="   } 

Si vous souhaitez récupérer vos attributs à un stade ultérieur, vous pouvez le faire en récupérant simplement votre document JSON :

GET https://sandbox.esignlive.com/api/packages/{packageId}/documents/{documentId}

Ensuite, bouclez sur la propriété du champ data.

Résultats

Voici un exemple de ce que vous pouvez vous attendre à voir une fois que vous aurez exécuté votre code.

Tableau des données utiles de la demande