Référence de l'API

Champs

Là où chaque signataire signe, paraphe, date ou remplit. Les positions sont des fractions de la page.

Points de terminaison · 4

POST Ajouter des champs
GET Lister les champs
PATCH Mettre à jour un champ
DELETE Supprimer un champ

L'objet

Champ	Saisir	Description
`id`	string	Identifiant unique, commençant par fld_.
`object`	string	Toujours "field".
`recipient_id`	string	Le signataire qui le remplit.
`file_id`	string	Le fichier où il se trouve.
`type`	enum	signature, initials, date_signed, name, text, checkbox ou attachment (le signataire téléverse un fichier).
`page`	integer	Numéro de page dans ce fichier, à partir de 1.
`x, y`	number	Coin supérieur gauche, en fraction de la largeur et de la hauteur de la page (de 0 à 1), depuis le coin supérieur gauche de la page.
`width, height`	number	Taille en fraction de la page (de 0,005 à 1).
`required`	boolean	Si le signataire doit le remplir. Les cases à cocher ne sont jamais obligatoires.
`label`	string ou null	Montré au signataire, jusqu'à 80 caractères.

POST/documents/{id}/fields

Ajouter des champs

Brouillons seulement. Renvoie tous les champs du document.

Paramètre	Saisir		Description
`fields`	array	obligatoire	De 1 à 500 champs. Chacun a recipient (un identifiant de destinataire, ou un courriel), type, page, x, y, width, height et, au besoin, file (un identifiant de fichier; par défaut le premier fichier), required et label.

Requête

bash

curl -X POST "https://api.esorasign.com/v1/documents/doc_3y9Pf34qY6Nb3wWD25RQ4F/fields" \
  -H "Authorization: Bearer $ESORA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "fields": [ { "recipient": "rcp_5ZR3qa7yEeeby3abP3E2Zs", "type": "signature", "page": 6, "x": 0.12, "y": 0.71, "width": 0.3, "height": 0.06 } ] }'

Réponse

json

{
  "object": "list",
  "data": [
    {
      "id": "fld_2a3dDVhYRnKTbxTNJFoBin",
      "object": "field",
      "recipient_id": "rcp_5ZR3qa7yEeeby3abP3E2Zs",
      "file_id": "file_5aJXVuLkSIc47WQAmL9xVQ",
      "type": "signature",
      "page": 6,
      "x": 0.12,
      "y": 0.71,
      "width": 0.3,
      "height": 0.06,
      "required": true,
      "label": null
    }
  ],
  "has_more": false,
  "next_cursor": null
}

GET/documents/{id}/fields

Lister les champs

Par page, de haut en bas.

Requête

bash

curl "https://api.esorasign.com/v1/documents/doc_3y9Pf34qY6Nb3wWD25RQ4F/fields" \
  -H "Authorization: Bearer $ESORA_API_KEY"

Réponse

json

{
  "object": "list",
  "data": [
    {
      "id": "fld_2a3dDVhYRnKTbxTNJFoBin",
      "object": "field",
      "recipient_id": "rcp_5ZR3qa7yEeeby3abP3E2Zs",
      "file_id": "file_5aJXVuLkSIc47WQAmL9xVQ",
      "type": "signature",
      "page": 6,
      "x": 0.12,
      "y": 0.71,
      "width": 0.3,
      "height": 0.06,
      "required": true,
      "label": null
    }
  ],
  "has_more": false,
  "next_cursor": null
}

PATCH/documents/{id}/fields/{field_id}

Mettre à jour un champ

Brouillons seulement.

Paramètre	Saisir		Description
`page, x, y, width, height, required, label`		facultatif	Comme dans Ajouter des champs.

Requête

bash

curl -X PATCH "https://api.esorasign.com/v1/documents/doc_3y9Pf34qY6Nb3wWD25RQ4F/fields/fld_2a3dDVhYRnKTbxTNJFoBin" \
  -H "Authorization: Bearer $ESORA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "y": 0.74 }'

Réponse

json

{
  "id": "fld_2a3dDVhYRnKTbxTNJFoBin",
  "object": "field",
  "recipient_id": "rcp_5ZR3qa7yEeeby3abP3E2Zs",
  "file_id": "file_5aJXVuLkSIc47WQAmL9xVQ",
  "type": "signature",
  "page": 6,
  "x": 0.12,
  "y": 0.71,
  "width": 0.3,
  "height": 0.06,
  "required": true,
  "label": null
}

DELETE/documents/{id}/fields/{field_id}

Supprimer un champ

Brouillons seulement.

Requête

bash

curl -X DELETE "https://api.esorasign.com/v1/documents/doc_3y9Pf34qY6Nb3wWD25RQ4F/fields/fld_2a3dDVhYRnKTbxTNJFoBin" \
  -H "Authorization: Bearer $ESORA_API_KEY"

Réponse

json

{ "id": "fld_2a3dDVhYRnKTbxTNJFoBin", "object": "field", "deleted": true }