Le but de cette documentation est d'illustrer l'utilisation possible de l'API Koban.
Votre application, s'il s'agit d'une application web et que vous utilisiez l'API en mode client devra être sécurisée en renseignant le . Ceci se fait dans votre application Koban sous Paramètres > API.
Chaque appel à l'API nécessite une authentification via une clé d'API. Cette clé peut être récupérée sur votre compte Koban sous Paramètres > API.
Pour chaque appel REST à l'API, les en-têtes HTTP suivants sont nécessaires pour s'authentifier Nous conseillons fortement de transmettre la clé User plutot que son login :
X-ncApi : La clé d'API
X-ncUser : Le login de l'utilisateur ou sa clé (chaque clé est listée sous Paramètres > API)
GET https://app-koban.com/api/v1/ncLead/GetPending?st=0&s= HTTP/1.1
Host: app-koban.com
Connection: keep-alive
X-ncApi: VOTRE CLE
X-ncUser: VOTRE LOGIN OU VOTRE CLE UTILISATEUR
Accept: application/json
Tout appel à l'API est enregistré. Vous pouvez consulter l'historique des appels sous Paramètres > API. Par défaut, chaque compte a un quota de 5000 appels par jour (attention, ce quota intègre également les synchronisations avec l'application mobile, Outlook et les extensions comme Google Calendar). Contactez-vous si vous souhaitez une extension.
Toutes les méthodes d'API sont accessibles via REST sous les verbes GET, POST, PUT, DELETE. Vous pouvez donc facilement intégrer des appels à partir de votre code coté serveur (PHP ou C# par exemple).
Pour chaque appel POST ou PUT, certaines propriétés doivent obligatoirement être remplies (par exemple Name pour une piste). Si la demande est incomplète, une erreur HTTP 400 BadRequest est renvoyée par l'API.
Une librairie javascript est disponible à l'adresse suivante : https://app-koban.com/libapi/koban.js. Elle vous permet d'utiliser rapidement les principales méthodes d'API disponibles.
Attention ! Vous devez intégrer jquery avant d'utiliser cette bibliothèque.
L'ensemble des méthodes accessibles via l'API sont détaillées ci-dessous en fonction de l'objet concerné : Compte, contact, opportunité...
Tous les objets renvoyés comportent une propriété Guid : Il s'agit de l'identifiant unique de la ressource qu'on peut employer pour lier les objets entre eux (par exemple au niveau des actions).
Regroupe toutes les méthodes de sélection des utilisateurs
Regroupe toutes les méthodes de manipulation du fil de notification
Regroupe toutes les méthodes de manipulation des listes
Regroupe toutes les méthodes de manipulation des tags
Regroupe toutes les méthodes de manipulation des objets personnalisés
Regroupe toutes les méthodes de manipulation des comptes (entreprises prospect, client ou particuliers...)
Regroupe toutes les méthodes de manipulation des types de comptes
Regroupe toutes les méthodes de manipulation des statuts de comptes
Regroupe toutes les méthodes de manipulation des contacts rattachés à un compte (salariés ou dirigeant d'entreprises...)
Regroupe toutes les méthodes de manipulation des types d'actions
Regroupe toutes les méthodes de manipulation des actions commerciales
Regroupe toutes les méthodes de manipulation des opportunités
Regroupe toutes les méthodes de manipulation des processus
Regroupe toutes les méthodes de manipulation des pistes
Regroupe toutes les méthodes de manipulation des call to action
Regroupe toutes les méthodes de manipulation des formulaires
Regroupe toutes les méthodes de manipulation des landing pages
Regroupe toutes les méthodes de manipulation des emailings
Regroupe toutes les méthodes de manipulation des scénarios Marketing
Regroupe toutes les méthodes de manipulation des types de campagne Marketing
Décrit les techniques de conception des modèles d'emails Koban
Décrit les techniques de conception des modèles d'emails Koban
Ensemble de ressources techniques vous permettant d'intégrer Koban Marketing à votre existant (site internet, application...)
Décrit de l'aide supplémentaire sur les modèles de document Koban
Regroupe toutes les méthodes de manipulation des catégories de produits
Regroupe toutes les méthodes de manipulation des produits
Regroupe toutes les méthodes de manipulation des devis
Regroupe toutes les méthodes de manipulation des bons de commande
Regroupe toutes les méthodes de manipulation des factures
Regroupe toutes les méthodes de manipulation des règlements
Regroupe toutes les méthodes de manipulation des dépots
Regroupe toutes les méthodes de manipulation des stocks
Regroupe toutes les méthodes de manipulation des projets
Koban permet de paramétrer des webhooks au niveau de plusieurs évènements. Au déclenchement de cette évènement (par exemple une modification d'un compte), Une URL est appelée en POST avec un payload correspondant à la donnée concernée.