DOCS

Guide de démarrage

Bienvenue dans la documentation de l'API Chorus Pro. Ce guide vous aidera à démarrer avec l'API, à comprendre les méthodes d'authentification et à effectuer votre première requête.

URLs de base

L'API Chorus Pro est disponible sur les environnements suivants :

Production

API:https://api.piste.gouv.fr/cpro

OAuth:https://oauth.piste.gouv.fr

Environnement de production pour les requêtes réelles avec données réelles.

Sandbox

API:https://sandbox-api.piste.gouv.fr/cpro

OAuth:https://sandbox-oauth.piste.gouv.fr

Environnement sandbox pour le développement et les tests.

Méthodes d'authentification

L'API Chorus Pro requiert 2 méthodes d'authentification :

OAuth 2.0 (Bearer Token)

Token OAuth 2.0 obtenu via la méthode client_credentials. Requis pour toutes les requêtes API.

Authorization: Bearer YOUR_OAUTH_TOKEN

En-tête cpro-account

Identifiants du compte Chorus Pro encodés en base64 sous la forme 'login:password'.

cpro-account: base64(login:password)

1. Obtenir un token OAuth 2.0

Avant d'effectuer des requêtes, vous devez obtenir un token OAuth 2.0 :

# Production
curl -X POST "https://oauth.piste.gouv.fr/api/oauth/token" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "grant_type=client_credentials" \
  -d "client_id=YOUR_CLIENT_ID" \
  -d "client_secret=YOUR_CLIENT_SECRET" \
  -d "scope=openid resource.READ"

# Sandbox
curl -X POST "https://sandbox-oauth.piste.gouv.fr/api/oauth/token" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "grant_type=client_credentials" \
  -d "client_id=YOUR_CLIENT_ID" \
  -d "client_secret=YOUR_CLIENT_SECRET" \
  -d "scope=openid resource.READ"

2. Votre première requête

Voici un exemple de requête pour vérifier la santé de l'API :

# Production
curl -X GET "https://api.piste.gouv.fr/cpro/transverses/v1/health-check" \
  -H "Authorization: Bearer YOUR_OAUTH_TOKEN" \
  -H "cpro-account: $(echo -n 'login:password' | base64)" \
  -H "Content-Type: application/json"

# Sandbox
curl -X GET "https://sandbox-api.piste.gouv.fr/cpro/transverses/v1/health-check" \
  -H "Authorization: Bearer YOUR_OAUTH_TOKEN" \
  -H "cpro-account: $(echo -n 'login:password' | base64)" \
  -H "Content-Type: application/json"

⚠️ Important: Toutes les requêtes nécessitent DEUX authentifications : le token OAuth 2.0 ET l'en-tête cpro-account.

Notes importantes

📋 Méthode POST pour tout

L'API Chorus Pro utilise la méthode POST pour presque toutes les opérations, même pour la récupération de données. Les couleurs des badges vous aident à identifier le type d'opération (lecture en vert, création en bleu).

🔐 Double authentification

Chaque requête nécessite à la fois un token OAuth 2.0 (Authorization Bearer) et un en-tête cpro-account avec vos identifiants encodés en base64.

⚡ Format des réponses

Les réponses incluent généralement un champ 'codeRetour' (0 = succès) et un champ 'libelle' avec le message. Consultez les exemples de réponse pour chaque endpoint.

Support et ressources

Besoin d'aide ? Consultez les ressources :

🌐Documentation officielle Chorus Pro : portail.chorus-pro.gouv.fr/aife_documentation/
📚Documentation API complète : Parcourez les endpoints dans la barre latérale
🔑Obtenir des accès API : https://www.data.gouv.fr/dataservices/api-chorus-pro/
✅Créer un compte technique (pour l'identifiant et le mot de passe) : Tutoriel