Aller au contenu

DOCUMENTATION DÉVELOPPEURS

Documentation API

Intégrez la puissance de SIGNESTO dans vos applications. Une API simple, sécurisée et complète pour automatiser vos signatures email professionnelles.

SIGNESTOAPI
POSThttps://api.signesto.com/v1/signatures
{  "name": "Nouvelle signature",  "template_id": "tpl_123456",  "user_id": "usr_789012",  "data": {    "first_name": "Julie",    "last_name": "Martin",    "job_title": "Responsable Marketing"  }}
  • Une API REST moderne et facile à intégrer

  • Sécurisée et conforme aux standards

  • Des exemples concrets dans plusieurs langages

  • Une documentation toujours à jour

Vue d'ensemble

L'API SIGNESTO vous permet de gérer programmatiquement toutes les fonctionnalités de la plateforme : signatures, collaborateurs, modèles, bannières et plus encore.

  • Simple à intégrer

    API REST avec JSON

  • Sécurisée

    OAuth 2.0 et tokens API

  • Complète

    Toutes les fonctionnalités

  • Toujours à jour

    Nouvelles fonctionnalités régulièrement

Premiers pas

Suivez ces étapes simples pour faire votre première requête API en quelques minutes.

  1. 1

    Créez un compte

    Inscrivez-vous sur SIGNESTO et accédez à votre espace développeur.

  2. 2

    Récupérez vos clés

    Générez un token API depuis les paramètres de votre compte.

  3. 3

    Faites votre première requête

    Testez l'API avec notre exemple ci-dessous.

  4. 4

    Intégrez et développez

    Consultez la documentation des endpoints et SDKs.

Authentification

L'API utilise une authentification par token Bearer. Vous devez inclure votre token dans l'en-tête de chaque requête.

Authorization: Bearer votretoken_api

Vos tokens API sont disponibles dans les paramètres de votre compte. Gardez-les confidentiels et ne les partagez jamais.

Exemple de requête

Voici un exemple pour créer une signature avec cURL, JavaScript et Python.

curl -X POST https://api.signesto.com/v1/signatures \  -H "Authorization: Bearer votretoken_api" \  -H "Content-Type: application/json" \  -d '{    "name": "Signature équipe commerciale",    "template_id": "tpl_123456",    "user_id": "usr_789012",    "data": {      "first_name": "Thomas",      "last_name": "Dubois",      "job_title": "Directeur Commercial"    }  }'

Réponse exemple

{  "id": "sig_abc123def456",  "name": "Signature équipe commerciale",  "status": "active",  "html": "<div>...</div>",  "created_at": "2024-01-15T10:30:00Z",  "template_id": "tpl_123456",  "user_id": "usr_789012"}

Paramètres courants

Les principaux paramètres pour créer une signature.

ParamètreTypeRequisDescription
namestringOuiNom de la signature
template_idstringOuiID du modèle à utiliser
user_idstringOuiID de l'utilisateur
dataobjectOuiDonnées à injecter dans le modèle
data.first_namestringOuiPrénom du collaborateur
data.last_namestringOuiNom du collaborateur
data.job_titlestringNonPoste du collaborateur
data.phonestringNonTéléphone
data.websitestringNonSite web

Endpoints

Les ressources disponibles sur https://api.signesto.com. Chaque appel est limité à l'espace de travail de la clé API utilisée.

MéthodeCheminDescription
GET/v1/signaturesLister les signatures de vos collaborateurs
POST/v1/signaturesCréer une signature à partir d'un modèle
GET/v1/collaboratorsLister les collaborateurs de votre entreprise
POST/v1/collaboratorsAjouter un collaborateur
GET/v1/templatesLister vos modèles de signature
POST/v1/templatesCréer un modèle de signature
GET/v1/campaignsLister vos campagnes de bannières
POST/v1/campaignsCréer une campagne de bannières

Webhooks

Recevez une requête POST signée sur votre URL à chaque événement de signature. Les webhooks se configurent depuis votre espace, avec vos clés API. Configurer mes webhooks

Codes d'erreur

L'API utilise les codes HTTP standards. Le corps de chaque erreur est un objet JSON décrivant le problème.

  • 400Requête invalide : un paramètre est manquant ou mal formé
  • 401Clé API absente, invalide ou révoquée
  • 402Abonnement SIGNESTO requis (subscription_required)
  • 403Fonctionnalité non incluse dans votre offre
  • 404Ressource introuvable dans votre espace
  • 429Trop de requêtes : limite par seconde (rate_limited) ou quota mensuel (quota_exceeded) atteint
  • 500Erreur interne, réessayez dans quelques instants

Rate limits

L'API est incluse dans l'abonnement SIGNESTO (essai de 48 h compris) : 1 000 requêtes par mois et par espace, et 10 requêtes par seconde par clé API.

Au-delà de 10 requêtes par seconde, l'API répond 429 rate_limited : attendez la durée indiquée par l'en-tête Retry-After avant de relancer la requête.

Le quota mensuel est remis à zéro le 1er de chaque mois (UTC). Une fois les 1 000 requêtes atteintes, l'API répond 429 quota_exceeded avec un en-tête Retry-After jusqu'au mois suivant. Sans abonnement actif, elle répond 402 subscription_required.

Référence interactive de l'API

SDKs officiels

Utilisez nos SDKs pour une intégration encore plus simple.

  • JavaScript / Node.js

    sdk-signesto

    Installation rapide avec npm.

    npm install @signesto/sdk
  • Python

    signesto-python

    Une bibliothèque officielle pour Python.

    pip install signesto
  • PHP

    signesto-php

    Intégrez facilement dans vos applications PHP.

    composer require signesto
  • cURL

    Requêtes HTTP

    Utilisez cURL pour tester rapidement l'API.

    Voir les exemples

Environnements

L'API est disponible dans plusieurs environnements.

  • Production

    https://api.signesto.com

    Environnement de production pour vos applications.

  • Sandbox

    https://sandbox.api.signesto.com

    Environnement de test pour vos développements.

Changelog

Les dernières nouveautés de l'API.

  1. v1.0.0Première version publique : clés API, endpoints signatures, collaborateurs, modèles et campagnes, webhooksNouveau

Questions fréquentes

Créez une clé depuis votre espace, rubrique Intégrations › API et webhooks. La clé complète n'est affichée qu'une seule fois : copiez-la et conservez-la en lieu sûr.

Oui. L'abonnement inclut 1 000 requêtes par mois et par espace, et 10 requêtes par seconde par clé. Au-delà, l'API répond 429 avec un en-tête Retry-After.

Oui, l'environnement sandbox sur https://sandbox.api.signesto.com vous permet de tester votre intégration sans toucher à vos signatures en production.

Toutes les réponses sont en JSON (UTF-8). Les signatures incluent aussi leur rendu HTML dans le champ html.

Besoin d'aide ?

Notre équipe est là pour vous accompagner dans votre intégration.

Prêt à intégrer SIGNESTO dans vos applications ?

Commencez dès maintenant et donnez de la puissance à vos signatures.

Obtenir mon token API
  • Simple
  • Rapide
  • Sans engagement