Passer au contenu principal

Comment utiliser les clés API Formaloo dans l’API Formaloo

Apprenez à utiliser les clés API Formaloo : obtenez une clé API et une clé secrète, récupérez des jetons d’autorisation et appelez les API en toute simplicité.

Formaloo vous fournit votre propre jeton de clé API et vos propres secrets, afin que vous puissiez écrire vos propres API ou les utiliser avec n’importe quel SDK disponible pour Formaloo.
​
Pour écrire votre propre API personnalisée, vous devez suivre ces étapes :
​
1- Obtenez votre clé API (API Key) et votre clé secrète (Secret Key) auprès de Formaloo.
​
2- Utilisez la clé secrète pour obtenir des jetons d’autorisation (Authorization Tokens) à durée limitée.
​
3- Utilisez la clé API et le jeton d’autorisation pour appeler l’API souhaitée.
​
Nous décrivons chaque étape avec des exemples dans les parties suivantes :
​​
​

Clés API

ℹ️ Si vous devez renouveler votre clé secrète API, cette fonctionnalité est disponible avec le forfait Enterprise. Vous pouvez contacter l’assistance Formaloo pour en savoir plus et consulter notre page de tarifs.

Cliquez sur « Formaloo » pour afficher vos clés API
​

1. Obtenir les jetons


Pour obtenir la clé API et la clé secrète, rendez-vous sur https://cdp.formaloo.net/, accédez à l’onglet Connections, sélectionnez l’intégration Formaloo, puis, sur la page de l’intégration, copiez la clé API et la clé secrète. (Remarque : la clé en écriture seule (write-only key) est réservée aux rares cas où vous souhaitez créer une application mobile qui écrit des données en votre nom. Dans la quasi-totalité des scénarios habituels, vous n’en aurez pas besoin.)
​
​Clé API : cette clé sert à identifier votre application et l’intégration que vous utilisez. Vous devez l’inclure dans toutes les requêtes, avec l’en-tête x-api-key.
​
​Clé secrète : vous aurez besoin de cette clé pour obtenir les jetons d’autorisation envoyés dans toutes les requêtes. Notez que le jeton d’autorisation a une durée de vie courte et expire au bout de 30 secondes, tandis que la clé secrète n’expire pas et peut être utilisée pour obtenir autant de jetons d’autorisation que vous le souhaitez.
​

2. Obtenir un jeton d’autorisation


L’étape suivante consiste à utiliser votre clé secrète pour obtenir un jeton d’autorisation. Pour cela, il vous suffit d’envoyer une requête POST au point de terminaison suivant : https://api.formaloo.net/v1.0/oauth2/authorization-token/
​
Votre requête doit contenir l’en-tête et le corps suivants :
​
​En-tête :
​
Authorization = Basic {Secret Key}
​
​Corps (form-data) :
​
grant_type=client_credentials
​
​Exemple (cURL)
​

curl '' \\ --header 'Authorization: Basic {Secret Key}' \\ --form 'grant_type="client_credentials"'


​Exemple (Python)
​
​

import requests url = "" payload={'grant_type': 'client_credentials'} headers = { 'Authorization': f'Basic {secret_key}' } response = requests.post( url, headers=headers, data=payload ) if response.status==200: authorization_token = response.json().get('authorization_token')


​Réponse
​
​

{ "authorization_token": "{Authorization Token}" }


Si votre clé secrète est valide et que vous envoyez correctement la requête, vous recevrez dans la réponse un jeton d’autorisation, que vous pourrez utiliser pour appeler l’API avant son expiration et son renouvellement.
​

3. Appeler l’API Formaloo


À ce stade, vous disposez d’une clé API valide et d’un jeton d’autorisation actif. Il vous suffit maintenant d’inclure chacun d’eux dans l’en-tête approprié pour authentifier votre appel d’API :
​
​En-tête :
​

Authorization = JWT {Authorization Token} x-api-key = {API Key}


Notez que toutes les API (à l’exception de l’API d’autorisation) nécessitent l’en-tête x-api-key, tandis que certaines (par exemple, l’envoi d’un formulaire) ne nécessitent pas l’en-tête Authorization. Consultez la documentation de l’API pour savoir quels points de terminaison ne nécessitent pas l’en-tête Authorization.
​
​Exemple de requête (cURL) :
​

curl '' \\ --header 'x-api-key: {API Key}' \\ --header 'Authorization: JWT {Authorization Token}'


​Exemple de requête (Python) :
​

import requests url = "https://api.formaloo.net/v3/forms/" headers = { 'x-api-key': f'{api_key}', 'Authorization': f'JWT {authorization_token}' } response = requests.get( url, headers=headers )


​

Avez-vous trouvé la réponse à votre question ?