Loading....

Introduction

Les aides proposées par l'AIFE vous permettront de faire les premiers tests et appels API vers la qualification puis vers la production. Ces aides sont à partager avec la communauté de développeurs API. Vous pouvez contribuer à l'enrichissement de ces aides en nous contactant par e-mail.

Rappel des pré-requis

Voici les pré requis pour pouvoir faire des appels API en qualification :

Ces trois étapes vous permettent de faire des appels API en qualification.

1er test API avec SOAP UI

Test pas à pas

La plateforme ChorusPro permet de gérer par webservice les factures envoyées aux clients institutionnels. Pour réaliser la connexion, il faut : - une structure identifiée (SIRET de la société maîtresse) qui supervise éventuellement d’autres structures (autres SIRET) - un utilisateur gestionnaire (principal ou secondaire) - un compte utilisateur technique attaché à la structure - activer les droits d’accès à l’API pour cette structure.

  • Installer SOAPUI
  • Disposer d'un access token via piste

Au préalable de l’exécution de l’appel API Chorus Pro, l’utilisateur doit récupérer un « Access Token ». La récupération de ce jeton est décrite dans le guide utilisateur de PISTE.

 

Afin de procéder à l’appel, suivre les étapes suivantes pour paramétrer le SOAPui:

Depuis la fenêtre de l’appel SOAPui, cliquer sur « Auth » (encadré rouge ci-dessous)

  • Suite au clic, le bloc d’authentification s’affiche comme illustré ci-dessous :

  • Sélectionner « Add new authorization », une nouvelle pop-in s’affiche :

  • Préciser dans le champ « type », la valeur OAuth2.0 et choisir un profil

  • Suite à la validation, la nouvelle authorization est créée :

  • Cliquer sur « Get Token »

  • Dans “Oauth 2 Flow” sélectionner « Client Credentials Grant »
  • Copier le Client ID et le Client Secret – qui sont récupérables dans PISTE comme décrit dans le guide utilisateur PISTE dans la rubrique « 6.5 Génération d’une Api Key » du guide utilisateur PISTE UserGuide_navigation_FR (version du 12/08)
  • Remplir l’Access Token URL en fonction d’où doit être effectué l’appel (zone Internet ou ADER). Pour cela se référer à la rubrique « 10.2 Liste des points d’accès PISTE par partenaire » du guide utilisateur PISTE UserGuide_navigation_FR (version du 12/08)
  • Scope = « openid »
  • Valider en cliquant sur Get Access Token

Une fois l’access Token généré, procéder à l’appel API Chorus Pro comme décrit ci-dessous :

  • La valeur obtenue lors du get access Token est automatiquement renseigné dans le champ Access Token (bloc « Authorization » Profile 1) :

  • Procéder à la création d’un Header en cliquant sur le bouton [Headers] et sur le « + » :

  • Saisir « cpro-account » comme nom de header et valider :

  • Lorsque le header est créé, renseigner dans le champ « Value » la combinaison « logintechnique:password » encodée en base 64
  • Exécuter l’appel API en cliquant sur la flèche verte et vous obtiendrez alors une réponse dans la zone de droite (onglet JSON).


Le
format d'encodage attendu : l’encodage du contenu doit être obligatoirement en UTF-8 (Content-Type: charset=UTF-8)

Récupération de l’access Token pour procéder à un appel API Chorus Pro en mode Oauth2 avec la commande Curl

De même que pour l’exécution de l’appel API Chorus Pro (depuis soapUi), l’utilisateur doit premièrement récupérer un « Access Token »via la commande Curl.

 

Le jeton est obtenu en curl en utilisant la commande suivante  depuis internet:

curl –k –H "content-type :application/x-www-form-urlencoded" –d "grant_type=client_credentials&client_id=XXXXX&client_secret=XXXXXXX&scope=openid" –X POST https://sandbox-oauth.aife.economie.gouv.fr/api/oauth/token

Ou la commande ci-dessous depuis le Réseau Interministériel de l'État (RIE):

curl –k –H "content-type :application/x-www-form-urlencoded" –d "grant_type=client_credentials&client_id=XXXXX&client_secret=XXXXXXX&scope=openid" –X POST https://sandbox-oauth.aife.finances.rie.gouv.fr/api/oauth/token 

Consommation de l’API en Curl

Pour consommer l’API, il faut effectuer la requête suivante (en ajoutant l’entête Authorization: Bearer à chaque requête) depuis internet :

curl -k -H "content-type: application/json; charset=UTF-8" -H "Authorization:Bearer <access_token>" -H "cpro-account:<logintechnique:password encodée en base 64>" --data '{votre_body_json}' –X POST https://sandbox-api.aife.economie.gouv.fr/{votre_API}

 

Ou la commande suivante depuis le réseau interministériel de l'État (RIE):

curl -k -H "content-type: application/json; charset=UTF-8" -H "Authorization:Bearer <access_token>" -H "cpro-account:<logintechnique:password encodée en base 64>" --data '{votre_body_json}' –X POST https://sandbox-api.aife.finances.rie.gouv.fr/{votre_API}

La réponse retournée est similaire à la capture écran ci-dessous:

Liste des URL PISTE pour accéder aux API CPRO

Nom d’accès URL Type d’accès
INTERNET https://sandbox-api.aife.economie.gouv.fr Consommation
INTERNET https://api.aife.economie.gouv.fr Consommation
INTERNET https://developer.aife.economie.gouv.fr Consommation
INTERNET https://sandbox-oauth.aife.economie.gouv.fr/api/oauth/token Obtention d’un jeton
INTERNET https://oauth.aife.economie.gouv.fr/api/oauth/token Obtention d’un jeton
ADER https://api.aife.finances.rie.gouv.fr Consommation
ADER https://oauth.aife.finances.rie.gouv.fr/api/oauth/token Obtention d’un jeton
ADER https://sandbox-api.aife.finances.rie.gouv.fr Consommation
ADER https://sandbox-oauth.aife.finances.rie.gouv.fr/api/oauth/token Obtention d’un jeton
Print Friendly, PDF & Email

Dernière mise à jour : avril 3, 2020  

4812  
Back To Top