Gérer les applications API

Créez les identifiants techniques utilisés par une application pour appeler l’API BizSign au nom de votre organisation.

En bref

La page API & Développeurs est réservée aux propriétaires et aux administrateurs de l’organisation. Elle présente les applications existantes, leurs droits, leur statut et leur dernier usage. La pastille d’en-tête indique Accès API actif ou Accès API non inclus selon votre offre.

Sous la liste, Sécurité & Authentification rappelle l’état de vérification de votre compte, avec Gérer la sécurité pour le modifier, et Facturation & Formule rappelle l’offre qui ouvre l’accès API, avec Voir mon abonnement et Consommation.

La création est disponible selon votre offre. Chaque application reçoit un Client ID et un Client secret. Le secret n’est affiché qu’une fois : copiez-le immédiatement dans un gestionnaire de secrets.

Étapes détaillées

1. Ouvrez API & Développeurs dans les paramètres.
2. Sélectionnez Créer une application.
3. Renseignez le Nom de l’application et, si nécessaire, sa Description.
4. Dans Scopes autorisés, cochez uniquement les droits indispensables à l’intégration.
5. Dans Limites de l’application, choisissez les Niveaux de signature autorisés, un Plafond mensuel d’actes et une Expiration (UTC) si nécessaire, puis sélectionnez Créer l’application.
6. Dans la confirmation, utilisez Copier pour enregistrer le Client ID puis le Client secret.
7. Après avoir enregistré les deux valeurs, sélectionnez J’ai copié le secret.
8. Utilisez ensuite Gérer sur la ligne de l’application pour modifier ses paramètres ou ses accès.

Règles métier et cas particuliers

• Les scopes disponibles dépendent de votre offre. Un droit grisé ne peut pas être accordé à l’application.
• Au moins un scope doit être sélectionné.
• Le Client secret n’est jamais affiché de nouveau après la fermeture de la confirmation ou le rechargement de la page.
• Ne placez jamais le secret dans du code source, une URL, une capture d’écran ou un journal applicatif.
• Si l’accès API n’est pas compris dans votre offre, utilisez Voir mon abonnement.
• Un appel direct sans ce droit est refusé avant tout décompte de quota.
• La liste affiche Jamais lorsqu’aucun jeton de l’application n’a encore été utilisé.
• Quota API du mois UTC indique le compteur partagé, le quota et la règle appliquée selon votre offre.
• Appels (30 j) compte les appels réussis de chaque application sur une période glissante qui peut traverser deux mois.
• Les appels API réussis consomment le quota mensuel partagé par l’organisation, selon votre offre. Les appels refusés ou en erreur ne sont pas comptabilisés.
• Chaque réponse réussie indique la limite, la consommation du mois UTC et la date de remise à zéro dans les en-têtes de quota.
• Lorsque le quota est atteint, les appels suivants sont refusés ou acceptés en dépassement selon votre offre.
• BizSign envoie des alertes à 80 % puis à 100 % de consommation au propriétaire et à l’adresse de facturation de l’organisation. Une même adresse ne reçoit pas deux fois la même alerte.
• Le dernier usage est mis à jour après un appel API réussi. Un appel refusé ou en erreur ne modifie pas cette date.
• Le détail de l’application permet de consulter ses jetons actifs et son activité récente sans afficher de secret.

Le Guide d’intégration API, accessible depuis cet écran et la fenêtre des identifiants, fournit l’URL de base, un exemple d’appel et la matrice de compatibilité.

• Les limites de l’application s’ajoutent à celles de l’offre : elles ne permettent jamais de les dépasser. Les niveaux sélectionnés doivent appartenir à l’offre lors de l’enregistrement.
• Le plafond d’actes compte les signataires réservés lors de l’envoi, y compris en Signature Immédiate. Une validation de relecteur ne consomme pas ce plafond. Ce compteur est distinct du nombre d’appels API et de la facturation.
• Un plafond vide reprend les seules limites de l’offre. Un plafond à zéro bloque tout nouvel envoi. Le compteur repart au début de chaque mois UTC ; tous les jetons d’une application partagent le même compteur.
• Une demande refusée avant son envoi ne consomme pas d’acte de l’application. Une annulation ou une suppression après l’envoi ne rend pas les actes réservés.
• Dans Gérer, le nombre d’actes réservés ce mois accompagne les réglages. Réduire le plafond sous la consommation déjà enregistrée bloque les prochains envois.
• L’expiration se saisit en UTC. Une application expirée ne peut plus obtenir de jeton ni utiliser ceux déjà émis. Elle peut être prolongée par un propriétaire ou un administrateur de l’organisation, depuis Gérer.