Utilisation de l'API

De PME-CRM
Aller à : navigation, rechercher

Présentation

L'utilisation de l'API vous permet de récupérer des données de votre compte PME CRM et de les affichés en code JSON. Il ne vous restera simplement qu'à récupérer le contenu et de le traité avec votre application externe. De plus, l'API vous permet de créer des nouvelles entités : enregistrement d'un contact, d'un client, d'une demande d'appel ou bien d'autres modules. Enfin, l'API vous permettra de mettre à jour et de supprimer une donnée de votre compte.

Télécharger l'API :

Afin de pouvoir utiliser l'API, il est nécessaire d'obtenir votre clé API. Pour cela, veuillez nous contacter par email en nous précisant votre nom d'instance. Un email vous sera envoyé afin de vous communiquer votre clé API.

  • Email de demande : support@pme-crm.fr

Ensuite, il vous restera tout simplement à activer l'API dans votre compte utilisateur.

Utilisation de l'API en PHP

Pour utiliser l'API PME CRM en PHP, vous pouvez utiliser notre plugin disponible en téléchargement.

Le plugin dispose d'un dossier "core" et du fichier principal "pmecrm.php".

Inclure l'API dans vos programmes

Pour inclure l'API, vous devez ajouter le code suivant :

include('pmecrm.php');

Configurez les accès vers votre CRM

Ajoutez une variable de type Array contenant les données de connexion API de votre CRM.

$config = array(

   'instance' => 'VOTRE_NOM_INSTANCE',
   'apikey' => 'VOTRE_CLE_API_A_DEMANDER_AU_SUPPORT',
   'userid' => 'VOTRE_ID_UTILISATEUR'

);

N'oubliez pas de remplacer les valeurs 'VOTRE_NOM_INSTANCE', 'VOTRE_CLE_API_A_DEMANDER_AU_SUPPORT', 'VOTRE_ID_UTILISATEUR'.

Exécuter l'appel vers l'API

$api = new PmeCrmAPI($config);

$PMECRM->create('Contact',

array(
   'civility' => 1, 
   'lastname' => 'DUPOND', 
   'firstname' => 'Olivier', 
   'phone' => '01 23 45 67 89', 
   'email' => 'dupond.olivier@societe.com'
 )

);


Cette exemple permet de créer un contact.

Utilisation de l'API en CURL

URL API

http://api.pme-crm.fr

Méthode REST API

POST

Prenons pour l'exemple, le module Contact :

http://api.pme-crm.fr/Contact POST civility=1&lastname=DUPONT&firstname=Oliver&phone=0123456789&email=dupond.olivier@societe.com