Documentation - API REST

Général

L'API SigTool est basée sur les principes REST. La communication s'effectue via le protocole HTTPS, l'action à effectuer est définie par le verbe HTTP, la ressource à créer ou à modifier est définie par l'URL de la requête, et l'authentification est basée sur une clé d'API specifique au compte client utilisé.

L'URL de base des appels API est https://www.sigtool.com/api. La plupart des réponses de l'API sont au format JSON, excepté pour l'accès à certaines ressources spécifiques, tel que les documents PDFs de la Signature, et les erreurs.

Authentification

L'API SigTool utilise une authentification HTTP de type Bearer, où le token fourni est la clé d'API du compte client.

Erreurs

Les erreurs d'appel API, que ce soit à cause de paramètres incorrects ou d'une quelconque autre raison, génèrent une réponse avec un code d'erreur HTTP approprié 4XX ou 500, et un contenu de type text/plain contenant la description de l'erreur.

404 Not found
Content-Type: text/plain; charset="utf-8"

Signature not found

API Signature

• Add signature
  Crée un nouvel objet Signature.
• Update signature
  Modifie un objet Signature existant.
• Delete signature
  Supprime un objet Signature existant.
• Search signature
  Recherche un ou plusieurs objets Signature.
• Get signature
  Retourne un objet Signature specifique.
• Get signature PDF
  Retourne le PDF d'origine ou signé d'un document d'un objet Signature specifique.
• Get signature image
  Retourne le PDF d'origine ou signé d'un document d'un objet Signature specifique, converti en image SVG.

Notifications

L'API SigTool peut notifier le client lorsqu'un signataire signe le ou les documents proposés par une Signature. Les différents modes de notification sont :

• HTTP
  L'API SigTool appellera une page web avec diverses informations concernant l'objet Signature. Cette méthode permet l'automatisation du téléchargement des documents signés. Voir la page Notification HTTP pour plus d'informations.
• E-mail
  Un E-mail référençant la Signature sera envoyé au client pour lui signaler que le ou les documents ont été signés.
• SMS
  Un SMS référençant la Signature sera envoyé au client pour lui signaler que le ou les documents ont été signés.