Passer au contenu principal

Documentation API – Récupération des signatures

R
Écrit par Romain Corredera
Mis à jour cette semaine

1. Génération de la clé API

Après avoir généré votre clé API (voir Comment gérer vos clés API (On Premise, SCIM, API Publiques) | Help center), vous pouvez utiliser notre API publique pour récupérer les signatures de vos collaborateurs.


La clé d'API doit être utilisée comme un Bearer Token (voir RFC 6750 - The OAuth 2.0 Authorization Framework: Bearer Token Usage).


2. Endpoint

GET https://api.letsignit.com/public/api/v1/signature/<USEREMAIL>

3. Headers requis

  • Accept: application/json

  • Authorization: Bearer <API_KEY>


4. Exemples d’utilisation

a) cURL

curl -X GET \
'https://api.letsignit.com/public/api/v1/signature/<USEREMAIL>' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <API_KEY>'

b) Python (requests)

import requests

url = "https://api.letsignit.com/public/api/v1/signature/<USEREMAIL>"
headers = {
"Accept": "application/json",
"Authorization": "Bearer <API_KEY>"
}
response = requests.get(url, headers=headers)
print(response.json())

c) Node.js (Axios)

const axios = require('axios');

const url = "https://api.letsignit.com/public/api/v1/signature/<USEREMAIL>";
const headers = {
"Accept": "application/json",
"Authorization": "Bearer <API_KEY>"
};

axios.get(url, { headers })
.then(response => console.log(response.data))
.catch(error => console.error(error));

5. Exemple de réponse

L’appel à l’API retourne un objet JSON avec la structure suivante :

{
"name": "Nom de la signature",
"content": "<html>Contenu de la signature en HTML</html>",
"reply": "<html>Contenu de la variante reply si définie</html>"
}

Description des champs

  • name (string) : Nom unique de la signature.

  • content (string) : Contenu principal de la signature au format HTML.

  • reply (string, optionnel) : Variante HTML utilisée pour les réponses, si définie.


6. Documentation complète

Vous pouvez consulter la documentation technique complète ici : Public API - Swagger UI.

Avez-vous trouvé la réponse à votre question ?