Injection de valeurs de champ

Java SDK.NET SDKREST APIAPEX SDK

Java SDK

.withDocument(DocumentBuilder.newDocumentWithName("Sample Contract")
    .enableExtraction()
    .fromStream(fs, DocumentType.PDF)
    .withInjectedField(FieldBuilder.textField()
        .withName("Text1")
        .withValue("200 E MAIN ST, PHOENIX AZ, 85123 USA"))
    .withInjectedField(FieldBuilder.textField()
        .withName("Text2")
        .withValue("Lawn mower"))
    .withInjectedField(FieldBuilder.textField()
        .withName("Text3")
        .withValue("Fertilizer"))
    .withInjectedField(FieldBuilder.textField()
        .withName("Text4")
        .withValue("100"))
    .withInjectedField(FieldBuilder.textField()
        .withName("Text5")
        .withValue("12 12 12"))
)

Kit de développement logiciel (SDK) .NET

.WithDocument(DocumentBuilder.NewDocumentNamed("sample contract")
    .EnableExtraction()
    .FromStream(fs, DocumentType.PDF)
    .WithInjectedField(FieldBuilder.TextField()
        .WithId("Text1")
        .WithName("Text1")
        .WithValue("200 E MAIN ST, PHOENIX AZ, 85123 USA"))
    .WithInjectedField(FieldBuilder.TextField()
        .WithId("Text2")
        .WithName("Text2")
        .WithValue("Lawn mower"))
    .WithInjectedField(FieldBuilder.TextField()
        .WithId("Text3")
        .WithName("Text3")
        .WithValue("Fertilizer"))
    .WithInjectedField(FieldBuilder.TextField()
        .WithId("Text4")
        .WithName("Text4")
        .WithValue("100"))
    .WithInjectedField(FieldBuilder.TextField()
        .WithId("Text5")
        .WithName("Text5")
        .WithValue("12 12 12"))
)

REST API

Pour télécharger l’exemple de code complet, consultez notre site Code Share . Le PDF utilisé dans cette rubrique se trouve here. Vous pouvez également voir cette fonctionnalité dans notre Démo interactive.

Bien que cette rubrique explique comment injecter des champs de texte dans un document, la même procédure peut être utilisée pour injecter n’importe quel type de champ non lié. Pour plus d’informations sur les types de champs non liés disponibles, reportez-vous à la section Form Building Fields.

Si vous avez besoin d’une comparaison avec la procédure de création d’objet de base, ou si c’est la première fois qu’une transaction est créée, reportez-vous à la section Creating and Sending a Transaction.

L’exemple de code ci-dessous vous montre comment modifier le bloc de document pour injecter des champs de texte. La méthode withName() est utilisée pour saisir le nom du champ de formulaire PDF dans lequel vous souhaitez injecter du texte, tel qu’il est nommé dans votre formulaire PDF. La méthode withValue() est utilisée comme texte que vous souhaitez tamponner sur votre document.

L’exemple JSON ci-dessous vous montre comment modifier l’objet document pour injecter des champs de texte. Dans l’objet fields, l’attribut name est le nom du champ de formulaire PDF dans lequel vous souhaitez injecter du texte. L’attribut value est l’endroit où vous entrez le texte que vous souhaitez injecter dans votre document. .

Requête HTTP

POST /api/packages

En-têtes HTTP

Accept: application/json   
Content-Type: multipart/form-data   

Charge utile 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" {
    "documents": [{
        "fields": [{
            "value": "200 E MAIN ST, PHOENIX AZ, 85123 USA",
            "name": "Text1"
        }, {
            "value": "Lawn mower",
            "name": "Text2"
        }, {
            "value": "Fertilizer",
            "name": "Text3"
        }, {
            "value": "100",
            "name": "Text4"
        }, {
            "value": "12 12 12",
            "name": "Text5"
        }],
        "extract": true,
        "name": "Sample Contract"
    }],
    "type": "PACKAGE",
    "status": "DRAFT",
    "roles": [{
        "id": "client",
        "index": 0,
        "type": "SIGNER",
        "signers": [{
            "email": "john.smith@example.com",
            "firstName": "John",
            "lastName": "Smith",
            "id": "client"
        }],
        "name": "client"
    }, {
        "id": "contractor",
        "index": 1,
        "type": "SENDER",
        "signers": [{
            "email": "myemail@example.com",
            "firstName": "Haris",
            "lastName": "Haidary",
            "id": "contractor"
        }],
        "name": "contractor"
    }],
    "name": "Field Injection Example"
}-- -- --WebKitFormBoundary1bNO60n7FqP5WO4t--

Pour une description complète de chaque champ, consultez le tableau Charge utile de la demande ci-dessous.

Charge utile de réponse

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

Résultats

Une fois que vous avez exécuté votre code, vos champs de texte apparaîtront dans les documents de votre transaction.

Tableau des données utiles de la demande

APEX SDK

String documentId = 'document1';
StaticResource sr = [SELECT Id, Body FROM StaticResource WHERE Name = 'test_field_injection' LIMIT 1];
Map<String, Blob> doc = new Map<String, Blob>();
doc.put(documentId, sr.Body);

ESignLiveAPIObjects.Document document = new ESignLiveAPIObjects.Document();
document.name = documentId;
document.id = documentId;
document.extract = true;

// Set field injection
ESignLiveAPIObjects.Field field1 = new ESignLiveAPIObjects.Field();
field1.name = 'Text1';
field1.value = '200 E MAIN ST, PHOENIX AZ, 85123 USA';

ESignLiveAPIObjects.Field field2 = new ESignLiveAPIObjects.Field();
field2.name = 'Text2';
field2.value = 'Lawn mower';

ESignLiveAPIObjects.Field field3 = new ESignLiveAPIObjects.Field();
field3.name = 'Text3';
field3.value = 'Fertilizer';

ESignLiveAPIObjects.Field field4 = new ESignLiveAPIObjects.Field();
field4.name = 'Text4';
field4.value = '100';

ESignLiveAPIObjects.Field field5 = new ESignLiveAPIObjects.Field();
field5.name = 'Text5';
field5.value = '12 12 12';

document.fields = new List<ESignLiveAPIObjects.Field>{field1, field2, field3, field4, field5};

sdk.createDocuments(packageId, document, doc);