API REST GlueCRM

Commandes disponibles et exemples d'API REST pour GlueCRM

Introduction

L'API fonctionne sur HTTPS et utilise JSON comme format de données.
L'API est une API RESTful et utilise des méthodes HTTP et des codes d'état HTTP pour spécifier les demandes et les réponses.
Un jeton est lié à toute une installation du CRM. Pour commencer à utiliser l'API, vous avez d'abord besoin d'un jeton API , après avoir activé notre module.

Créer un jeton d'API

Étape 1) Connectez-vous au backend du CRM en tant qu'administrateur, accédez à API → Gestion des API et créez un nouveau jeton.
Assurez-vous de copier le jeton et de remplir toutes les informations nécessaires.

Utilisation de l'API

Les commandes disponibles de l'API sont décrites ci-dessous, ainsi que leurs exemples de requête-réponse .
Nous vous suggérons fortement d'embaucher un professionnel, afin d'effectuer votre connexion tierce, si vous n'êtes pas familier avec les API, car nous ne pouvons pas vous guider à travers la compréhension de base des API REST (c'est une exigence pour utiliser cet élément et sort complètement du champ d'application des conditions de notre plan d'assistance).

Exemple d'utilisation - Exemple de commande GET

Pour cet exemple factice, nous utiliserons un jeton factice.

Disons que votre nouveau jeton est jEheVytlAoFl7F8MqUQ7jAo2hOXASet que vous devez répertorier tous les clients disponibles de l'installation du CRM, en utilisant l'API, via une requête cURL .

La commande que vous devrez exécuter sur votre terminal est la suivante :

curl -H "authtoken: jEheVytlAoFl7F8MqUQ7jAo2hOXAS" https : //mondomaine.com/api/customers

La réponse que vous êtes censé recevoir, sous un code d'état 200 OK, ressemblera à ce qui suit :

[
{
"stripe_id" : null,
"active" : "1",
"vat" : "1234567890",
"address" : "Test Address",
"billing_country" : "0",
"phonenumber" : "1234567890",
"registration_confirmed" : "1",
"longitude" : null,
"billing_city" : "",
"state" : "Test State",
"shipping_zip" : "",
"billing_zip" : "",
"city" : "Test City",
"shipping_country" : "0",
"billing_street" : "",
"datecreated" : "2019-11-29 12:34:56",
"company" : "Jk Technologies",
"shipping_street" : "",
"zip" : "123456",
"billing_state" : "",
"leadid" : null,
"addedfrom" : "8",
"userid" : "3",
"default_language" : "english",
"shipping_state" : "",
"show_primary_contact" : "0",
"country" : "102",
"default_currency" : "3",
"shipping_city" : "",
"latitude" : null,
"website" : "https://example.com"
},
{
"website" : "https://example2.com",
"latitude" : null,
"default_currency" : "0",
"shipping_city" : "London",
"country" : "235",
"show_primary_contact" : "0",
"shipping_state" : "Greater London",
"default_language" : "",
"addedfrom" : "1",
"userid" : "1",
"leadid" : null,
"billing_state" : "Greater London",
"zip" : "WC1 ASW",
"shipping_street" : "123 Road Street",
"company" : "Sample Company LTD",
"datecreated" : "2019-04-02 13:38:28",
"billing_street" : "123 Road Street",
"shipping_country" : "235",
"city" : "London",
"billing_zip" : "WC1 ASW",
"shipping_zip" : "WC1 ASW",
"longitude" : null,
"registration_confirmed" : "1",
"billing_city" : "London",
"state" : "Greater London",
"phonenumber" : "+44 210 7298299",
"billing_country" : "235",
"address" : "123 Road Street",
"vat" : "123456789",
"active" : "1",
"stripe_id" : null
}
]

Les champs personnalisés

Toutes les commandes prennent en charge les champs personnalisés, à partir de la version 1.0.2 du module.

Veuillez consulter la section Champs personnalisés afin de vous assurer de la bonne mise en œuvre de chaque demande comprenant des champs personnalisés.