Documentation de l'API pour la génération de signatures

⚡ Démarrage rapide

Trois étapes, de l'inscription à votre première signature.

🔗 URL de base

Toutes les réponses sont en JSON. En cas de succès : { "success": true, "data": {…}, "meta": {…} } ; en cas d'erreur : { "success": false, "error": { "code", "message" } }.

https://onlinesignatures.net/api/v1

🔑 Authentification

Chaque requête nécessite un jeton Bearer dans l'en-tête Authorization. Créez et gérez vos clés sur la page API de votre compte — la clé complète n'est affichée qu'une seule fois.

curl https://onlinesignatures.net/api/v1/usage \
  -H "Authorization: Bearer sk_live_your_token"

🎨 Formats de sortie

Par défaut, la signature est renvoyée en PNG transparent. Ajoutez le paramètre format pour obtenir un autre format — cela ne consomme pas de quota supplémentaire.

Clés = nombre de clés API que vous pouvez créer dans ce forfait. Requêtes / mois est le quota principal ; requêtes / minute est la limite anti-pics.

🔍 Qualité de l’image

Par défaut, la signature est renvoyée en qualité standard (1×). Ajoutez le paramètre quality pour obtenir une image plus grande et plus nette : 2× correspond à deux fois plus de pixels, 4× à quatre fois plus. Aucun quota supplémentaire n’est consommé.

curl -X POST https://onlinesignatures.net/api/v1/signatures \
 -H "Authorization: Bearer sk_live_..." \
 -H "Content-Type: application/json" \
 -d '{"first_name":"Signature",
      "last_name":"Generator",
      "format":"png",
      "quality":4}'

La même signature dans une autre qualité

Pour obtenir exactement la même signature dans une autre qualité, conservez le hash de la réponse et redemandez-la avec POST /api/v1/signatures/replay. Chaque appel compte pour une requête.

curl -X POST https://onlinesignatures.net/api/v1/signatures/replay \
 -H "Authorization: Bearer sk_live_..." \
 -H "Content-Type: application/json" \
 -d '{"hash":"eyJpdiI6...",
      "format":"png",
      "quality":4}'

Générez une toute nouvelle signature à partir d’un prénom et d’un nom.

curl -X POST https://onlinesignatures.net/api/v1/signatures \
 -H "Authorization: Bearer sk_live_..." \
 -H "Content-Type: application/json" \
 -d '{"first_name":"Signature",
      "last_name":"Generator"}'

curl -X POST https://onlinesignatures.net/api/v1/signatures \
 -H "Authorization: Bearer sk_live_..." \
 -H "Content-Type: application/json" \
 -d '{"first_name":"Signature",
      "last_name":"Generator",
      "format":"pdf"}'

Paramètres

{
  "success": true,
  "data": {
    "id": 1842,
    "hash": "eyJpdiI6...",
    "format": "pdf",
    "mime": "application/pdf",
    "signature": "data:application/pdf;
       base64,JVBER..."
  },
  "meta": { "quota": { "remaining":179 } }
}

{
  "success": false,
  "error": {
    "code": "format_not_allowed",
    "message": "The pdf format is
      not available on
      your plan."
  }
}

Régénérez une signature créée précédemment grâce à son hash. Vous pouvez aussi définir le format via ?format=.

curl "https://onlinesignatures.net/api/v1/signatures/{hash}?format=svg" \
  -H "Authorization: Bearer sk_live_your_token"

Renvoie votre forfait, les formats disponibles, la limite mensuelle, votre consommation et la date de réinitialisation.

{
  "success": true,
  "data": {
    "plan": "Business",
    "formats": ["png", "svg", "jpg"],
    "rate_per_minute": 1000,
    "key": { "name": "Production", "masked": "sk_live_a1b2…8f9c" },
    "quota": { "limit": 500, "used": 321, "remaining": 179 }
  }
}

⏱️ Limites et quota

Le quota mensuel est la limite principale et dépend de votre forfait (voir Forfaits API). Une limite de requêtes par minute (également selon le forfait) protège contre les pics. Les réponses incluent les en-têtes X-Quota-Limit, X-Quota-Remaining et X-Quota-Reset pour vous auto-réguler. Changer de format ne consomme pas de quota supplémentaire : une génération = une requête.

⚠️ Codes d’erreur