Help Center

Explore our knowledge base
article

Use the iAdvize API

Saving your conversation history, syncing the agents' availability with your CTI it is easy with our API. 
Our API allows you to automate the exchange of information with external tools.

1/ API Overview
2/ API Access
3/ Technical documentation


1/ API Overview

This article introduces different use cases our API can answer to. 
Firstly, you will find what you can do with it, then where you can look for information to use it, and in the last part we will give you a guide about the principal use cases of our API.
 
iAdvize offers 2 public APIs:
 
REST API allows you to access to iAdvize ressources mainly in reading mode. It is also possible to do other actions as creation, edition or suppression of many informations. Multiple applications are possible. For example, you can export data from your visitors, edit a user or add new conversation type to your conversation.
 
Webhook API allows you to listen to events from iAdvize. You can for example create your own reporting tool using events such as the conversation start/end, or the change of availability state of an agent. 
 



2/ API Access

To get your API key and then access to it, you must first make a request to create an API Key to our iAdvize customer help center.

To do so, click on your avatar displayed at the top right of your iAdvize administration. Then select "Help" to access the iAdvize Help Center :

You will automatically be logged into our Help Center, where you can send us a request.

Also to have your API key, please contact support.

3/ Technical documentation

If you want to use our API, create integrations for your own personal use or to share with the rest of the world, you should have a look to our developers platform documentation.

Whether you are a developer, an integrator, a customer or just curious, here  you will find an overview of how to get started, our Developer Guidelines, our API with practical examples and a guide to build and publish your future integrations.

Documentation > https://developers.iadvize.com/documentation

If you need some example or help about the syntax or the way to use our API, you can use our Github on the subject: https://github.com/iadvize/api-rest-client

Comments