Centre d'aide

Explorer notre base de connaissance
article

Utiliser l’API REST d’iAdvize.

1/ Fonctionnement global, introduction

En utilisant l'API REST d’iAdvize, vous pouvez exporter toutes les statistiques disponibles au sein de l'administration de la plateforme. L’API REST est une porte d’entrée vers les données stockées dans la base de données iAdvize.

Vous pouvez donc interroger notre base de données et y trouver la totalité des indicateurs présents dans les reporting de la solution iAdvize.

 

Screenshot_2019-06-04_at_17.47.38.png

2/ Demander votre clef API

Pour pouvoir utiliser nos API Rest et Push, vous devez au préalable effectuer une demande de création de Clé API auprès de notre support client iAdvize.

Pour cela, cliquez sur votre avatar (présent en haut à droite de votre interface) pour déployer vos options de profil. Cliquez ensuite sur "Aide" pour accéder à votre centre d'aide et de documentation iAdvize.

Vous serez alors automatiquement connecté, vous pourrez alors nous envoyer une demande.  

 

3/ Les ressources disponibles

L’intégralité des ressources accessibles depuis l’API REST est visible dans notre documentation.

 

4/ Construction d’une requête

Une requête est écrite en concaténant : Adresse de l’API + Type de ressource + séparateur +  Filtre website ID + & + Filtre API key + & + autres filtres...

 

Adresse de l’API : https://ha.iadvize.com/api/2/ (ou https://www.iadvize.com/api/2/ si vous êtes sur notre plateforme SD, c'est à dire que vous vous connectez à iAdvize depuis https://www.iadvize.com/admin/login/ )

Type de ressource : conversation (ou transaction ou operator ou… liste exhaustive )

Separateur : ?

Filtres website ID : filters[website_id]=XXXX

Filtre API key : key=xxxxxxxxxxxxxxxx

Autres filtres : filters[from]=2018-11-27 ou filters[channel]=chat (liste exhaustive)

 

Exemple complet :

https://ha.iadvize.com/api/2/conversation?filters[website_id]=XXXX&filters[channel]=chat&filters[from]=2018-11-27&filters[to]=2018-11-27&key=xxxxxxxxxxxxxxxx&full=true

 

 Séparation entre le coeur de la requête et les filtres effectuée en plaçant un « ? » avant le premier filtre puis des « & » entre chaque filtre.

 

Une fois votre requête construite, vous pouvez l’exécuter dans un logiciel spécialisé dans l’affichage des réponses d’API tels que Postman.

 

5/ Elements de syntaxes utiles.

- Afficher le maximum de détail dans les réponses

Rajouter "&full=true" à la fin d'une requête permet de déployer tous les enfants d’un objet parent et accéder ainsi au niveau maximum de détail.
 

- Pagination

Pour des raisons de performances, les résultats fournis par notre API sont paginés, cette pagination est détaillée à la fin de la réponse fournie par notre API, par exemple:

   "pagination": {

       "page": 1,

       "pages": 4,

       "limit": 20,

       "count": 79

   }

"page":  numéro de la page de résultat affichée, si plusieurs pages il faudra donc faire autant de requêtes qu’il existe de pages en ajoutant en fin de requête &page=2, &page=3 etc...

"pages": nombre total de pages de résultats pour la requête formulée

"limit": nombre de résultats par page, cette limite est modifiable (maximum 100) en ajoutant par exemple &limit=50 dans voss filtres

"count": nombre total de d'occurrence de réponse à la requête envoyé.

 
Dans l’exemple ci dessus nous avons 79 résultats qui se répartissent donc sur 4 pages contenant chacune 20 résultats au maximum (3 pages de 20 résultats et une page de 19 résultats précisément)

- Filtrer les transactions pour n’obtenir que celles suivant un chat

Le tag de transaction iAdvize remonte l’intégralité des transactions effectuées sur votre site. Pour n’obtenir des informations que sur celles suivant une conversation, vous devez rajouter un filtre s’assurant que les transactions affichées ont bien un conversation_id associé.

Pour cela vous devez ajouter à la fin de votre requête &filters[conversation_id]=!null (voir une application dans les exemples présentés dans l'article dédié "Exemples de requêtes API").

Pour obtenir des résultats heure par heure

Il est possible d'obtenir des résultats heure par heure en utilisant dans votre requête le filtre horaire &filters[from]=2019-04-01 01:00:00&filters[to]=2019-04-01 01:59:59.

 

5/ Autres utilisations de l'API Rest

Au delà de la consultation de statistiques, l'API Rest iAdvize permet également la consultation en temps réel de la disponibilité des agents, les requêtes liées à cet usage sont présentées ici.

 

 

Commentaires