- 06 Nov 2023
- 2 Minutos para leer
- Impresión
- OscuroLigero
Commencer à utiliser l'API Kizeo Forms (REST V3)
- Actualizado en 06 Nov 2023
- 2 Minutos para leer
- Impresión
- OscuroLigero
Étape 1 : Les bases
Avant d'utiliser notre API, vous devez être conscient que l'utilisation de celle-ci nécessite des compétences de développement en interne dans votre entreprise.
L'avantage d'une API (RESTful) est de pouvoir être utilisé facilement à l'aide de n'importe quel langage capable d'effectuer des requêtes HTTPS vers nos serveurs contenant des données json
. Voici une liste non-exhaustive de langages utilisables :
- C#
- C++
- Go
- Java
- Javascript
- Objective C
- Perl
- PHP
- Python
- Ruby
- Etc.
Ensuite, voici les différents liens qui vous seront utiles afin de développer votre application avec l'API de Kizeo Forms :
- Documentation Swagger : https://forms.kizeo.com/rest/v3/doc (cette présentation des fonctions permet de tester facilement les fonctionnalités de l'API).
- Racine de l'API :
https://forms.kizeo.com/rest/v3/
(par exemple, pour appeler la fonctionforms
, il faudra faire appel àhttps://forms.kizeo.com/rest/v3/forms
).
Récupération du Token
Pour accéder à toutes les fonctions, vous devez joindre la ligne ci-dessous en en-tête de vos requêtes HTTPS :
Authorization: YOUR_TOKEN
Pour obtenir le Token, vous devez en faire la demande par mail auprès de notre service support (support@kizeo.com). La demande doit émaner d’un Administrateur (l’adresse e-mail de l’émetteur doit correspondre à l’adresse e-mail dans Kizeo Forms).
Dans cette demande, il doit être spécifié :
- Le Code Entreprise
- L’Identifiant pour lequel le Token doit être créé (Administrateur ou d'un chef de groupe)
Si vous n'arrivez pas à faire marcher nos exemples de code, et que vous recevez comme code d'erreur un exemple comme le suivant :
Error : Call to undefined function curl_init(). // Ou une autre fonction dépendante de cURL
Pas de panique ! Nous vous recommandons d'effectuer les vérifications suivantes :
Si vous utilisez WAMP, vous devrez simplement activer l'extension en cliquant sur php_curl
dans PHP->PHP extensions
. Sinon, lisez la suite.
Étape 1 : Activation de l'extension cURL de PHP
Premièrement, allez voir dans votre fichier php.ini
et cherchez-y la ligne suivante :
;extension=php_curl.dll
Lorsque vous l'avez trouvée, il faudra la décommenter. Pour cela, supprimez le ";"
qui se trouve en début de ligne, et enregistrez le document.
Étape 2 : Modification de la variable d'environnement
Si cela n'a pas déjà été fait précédemment, vous aurez besoin, pour faire fonctionner cURL, de modifier la variable d'environnement PATH
.
Si vous ne savez pas comment modifier cette variable, voici comment procéder (sous Windows 10) :
- Ouvrir un explorateur de fichiers.
- Clic droit sur
Ce PC
puis clic gauche surPropriétés
. - Cliquer sur
Paramètres Système Avancés
. - Dans l'onglet
Paramètres système avancés
, cliquer surVariables d'environnement
. - Sélectionner la variable nommée
Path
puis cliquer surModifier
. - Entrer le chemin du dossier de PHP puis cliquer sur
Ok
. - Cliquer sur
Appliquer
.
Étape 3 : Relancer le service Apache
Après avoir relancé le service Apache pour qu'il prenne en compte les modifications que vous venez d'effectuer, la bibliothèque cURL devrait être opérationnelle.