Référence de l'API

Compte et espace de travail

Au nom de qui la clé agit, et son espace de travail.

Points de terminaison · 4

GET Qui suis-je
GET Lister les espaces de travail
GET Obtenir l'espace de travail
PATCH Modifier l'espace de travail

L'objet

Champ	Saisir	Description
`id`	string	Identifiant unique, commençant par wsp_.
`name`	string	Vient de votre organisation chez votre fournisseur de connexion.
`brand_name, brand_color`	string ou null	L'image de marque montrée aux destinataires. Réglée dans l'application.
`default_expires_in_days`	integer	Expiration par défaut des nouveaux documents.
`reminder_every_days`	integer ou null	Rappels par défaut.
`internal_domains`	array	Les domaines de courriel de votre organisation, utilisés par les règles d'approbation.
`embed_origins`	array	Les sites autorisés à afficher la page de signature dans un cadre.
`created_at`	timestamp

GET/users/me

Qui suis-je

La personne au nom de qui la clé agit.

Requête

bash

curl "https://api.esorasign.com/v1/users/me" \
  -H "Authorization: Bearer $ESORA_API_KEY"

Réponse

json

{ "id": "usr_4tDdO9eGzMcNU77sVTUUJ5", "object": "user", "name": "John Smith", "email": "john.smith@example.com", "api_key_id": "key_0P3C4DSA7Lc360a9Y6yNd1" }

GET/workspaces

Lister les espaces de travail

L'espace de travail de la clé.

Requête

bash

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

Réponse

json

{
  "object": "list",
  "data": [
    {
      "id": "wsp_16lLlGUriAX1DyyXN9iYw1",
      "object": "workspace",
      "name": "Northwind Traders",
      "brand_name": "Northwind",
      "brand_color": "#1F4E79",
      "default_expires_in_days": 30,
      "reminder_every_days": 3,
      "internal_domains": ["northwind.example"],
      "embed_origins": ["https://portal.northwind.example"],
      "created_at": "2026-07-14T08:30:00.000Z"
    }
  ],
  "has_more": false,
  "next_cursor": null
}

GET/workspaces/{id}

Obtenir l'espace de travail

Requête

bash

curl "https://api.esorasign.com/v1/workspaces/wsp_16lLlGUriAX1DyyXN9iYw1" \
  -H "Authorization: Bearer $ESORA_API_KEY"

Réponse

json

{
  "id": "wsp_16lLlGUriAX1DyyXN9iYw1",
  "object": "workspace",
  "name": "Northwind Traders",
  "brand_name": "Northwind",
  "brand_color": "#1F4E79",
  "default_expires_in_days": 30,
  "reminder_every_days": 3,
  "internal_domains": ["northwind.example"],
  "embed_origins": ["https://portal.northwind.example"],
  "created_at": "2026-07-14T08:30:00.000Z"
}

PATCH/workspaces/{id}

Modifier l'espace de travail

Les autres réglages (image de marque, équipe, règles d'approbation, conservation) sont dans l'application.

Paramètre	Saisir		Description
`embed_origins`	array	facultatif	Jusqu'à 20 origines comme https://portal.example.com (http://localhost pour le développement).
`default_expires_in_days`	integer	facultatif	De 1 à 365.

Requête

bash

curl -X PATCH "https://api.esorasign.com/v1/workspaces/wsp_16lLlGUriAX1DyyXN9iYw1" \
  -H "Authorization: Bearer $ESORA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "embed_origins": ["https://portal.northwind.example"] }'

Réponse

json

{
  "id": "wsp_16lLlGUriAX1DyyXN9iYw1",
  "object": "workspace",
  "name": "Northwind Traders",
  "brand_name": "Northwind",
  "brand_color": "#1F4E79",
  "default_expires_in_days": 30,
  "reminder_every_days": 3,
  "internal_domains": ["northwind.example"],
  "embed_origins": ["https://portal.northwind.example"],
  "created_at": "2026-07-14T08:30:00.000Z"
}