Aller au contenu principal

Environnements et authentification

Cette section présente les environnements disponibles dans Auco et la manière de vous authentifier de façon sécurisée lors de l’utilisation de l’API.

Versionnement de l’API​

Toutes les requêtes doivent inclure la version actuelle de l’API dans l’URL de base. Nous utilisons actuellement la version v1.5, le suffixe /ext indiquant les endpoints destinés aux intégrations externes.

Environnements disponibles​

Auco met à votre disposition deux environnements distincts :

🔧 Environnement de test (stage)​

  • URL de base : https://dev.auco.ai/v1.5/ext
  • Destiné aux intégrations, aux tests et au développement.
  • Aucun frais réel ni aucun mouvement réel de documents n’est généré.
  • Vous pouvez demander l’accès en créant un compte sur stage.auco.ai.

🚀 Environnement de production​

  • URL de base : https://api.auco.ai/v1.5/ext
  • Cet environnement exécute de véritables flux documentaires et comptabilise les documents signés ou livrés.
  • Nécessite un forfait de crédits actif et un compte de production correctement configuré.

Authentification​

L’API d’Auco utilise deux types de clés d’authentification : publique et privée. Ces clés doivent être incluses dans les en-têtes de la requête selon le type d’opération :

  • Lecture (GET) : utilisez la clé publique (puk_...)
  • Écriture (POST, PUT, DELETE) : utilisez la clé privée (prk_...)

🔑 En-tête obligatoire​

Authorization: YOUR_PUBLIC_OR_PRIVATE_KEY

📘 Exemple curl pour la lecture (GET)​

curl -X GET https://dev.auco.ai/v1.5/ext/document \
  -H "Authorization: puk_ocG0ODMlBlAN4NOi4GxVJjmC7Examaple" \
  -H "Content-Type: application/json"

📘 Exemple curl pour l’écriture (POST)​

curl -X POST https://dev.auco.ai/v1.5/ext/document/save \
  -H "Authorization: prk_ocG0ODMlBlAN4NOi4GxVJjmC7Examaple" \
  -H "Content-Type: application/json" \
  -d '{ "name": "document.pdf" }'

Remarque : conservez vos clés privées en lieu sûr. Ne les partagez jamais publiquement et ne les incluez jamais dans des clients publics tels que les navigateurs.

Recommandations​

  • Utilisez l’environnement stage pour tous vos premiers tests avant de passer en production.
  • Veillez à utiliser la clé publique pour GET et la clé privée pour POST, PUT et DELETE.
  • Mettez à jour à la fois l’URL de base et les clés lors du passage en production.
  • Protégez vos clés privées : ne les partagez jamais publiquement et ne les incluez jamais dans des clients publics tels que les navigateurs ou les applications mobiles.
  • Si vous automatisez des processus, envisagez de mettre en place une rotation périodique des clés.

Code d’erreur courant​

  • 401 Unauthorized : aucune clé valide n’a été incluse dans l’en-tête Authorization, ou le mauvais type de clé a été utilisé pour l’opération (lecture/écriture).