Organisation
Ce que l'organisation derrière votre clé API peut faire avec elle — plan, fonctionnalités et limites effectives.
GET /api/v1/organization
Décrit l'organisation à laquelle appartient la clé API appelante : son plan, les fonctionnalités dont elle dispose et ses limites effectives, forçages du back-office compris.
L'objet est renvoyé tel quel, sans enveloppe data. Pour savoir comment
s'en servir avant d'envoyer, voir
Connaître les capacités de sa clé.
Exemple
curl https://app.signlift.eu/api/v1/organization \
-H "X-Api-Key: $SIGNLIFT_API_KEY"Réponse 200
{
"id": 12,
"name": "Capsens",
"plan": "pro",
"environment": "sandbox",
"features": {
"sms_otp": true,
"initials": true,
"branding_profiles": true,
"transactional_sms": false
},
"limits": {
"documents_per_request": 10,
"branding_profiles": 2,
"transactional_sms_per_month": 10000,
"rate_limit": { "per_minute": 120, "per_hour": 3000 }
}
}Les valeurs ci-dessus illustrent la forme de la réponse : lisez toujours celles que renvoie l'API, qui dépendent de votre plan et de votre organisation.
Champs
| Champ | Type | Description |
|---|---|---|
id | integer | Identifiant de l'organisation. |
name | string | Nom de l'organisation. |
plan | string | free, simple, pro ou enterprise. |
environment | string | sandbox ou production : l'environnement de la clé appelante, pas de l'organisation. |
features | object | Fonctionnalités que le plan ouvre à l'organisation. |
limits | object | Limites effectives, forçages du back-office compris. |
features
| Champ | Type | Description |
|---|---|---|
sms_otp | boolean | Les signataires peuvent être authentifiés par code SMS. Aucun SMS n'est envoyé en sandbox. |
initials | boolean | Les paraphes sont disponibles (initials_required). |
branding_profiles | boolean | Les chartes graphiques sont disponibles. Un forçage peut l'ouvrir sur un plan qui ne l'inclut pas. |
transactional_sms | boolean | L'API SMS transactionnels est activée et utilisable. Sans rapport avec sms_otp. |
limits
| Champ | Type | Description |
|---|---|---|
documents_per_request | integer ou null | Nombre maximal de documents dans une demande de signature. null : illimité. |
branding_profiles | integer ou null | Nombre maximal de chartes graphiques. null : illimité. |
transactional_sms_per_month | integer | Plafond mensuel de SMS transactionnels créés en production, renvoyé même si le service n'est pas activé. |
rate_limit.per_minute | integer ou null | Appels par minute pour l'environnement de la clé. null : illimité. |
rate_limit.per_hour | integer ou null | Appels par heure pour l'environnement de la clé. null : illimité. |
Erreurs
| HTTP | Code | Quand |
|---|---|---|
| 401 | invalid_api_key | Clé absente, mal formée ou révoquée. |
| 402 | payment_required | Clé de production sur une organisation sans accès payant. |
| 429 | rate_limited | Plafond d'appels dépassé. Cet appel est compté comme les autres. |
L'appel porte les en-têtes X-RateLimit-* comme toute réponse authentifiée :
voir Limites et rate-limits.