API statistiques

1. Introduction

Axialys a conçu une plateforme qui permet de faire du trunk

Cette documentation va vous permettre de comprendre comment utiliser cette API afin de récupérer vos statistiques.

Ce document spécifie le protocole de communication HTTP utilisé pour la mise en place de Trunk afin d’interconnecter votre système à la plate ­forme et Axialys Interactive, afin que vous puissiez récupérer vos données concernant le Trunk.

Avant de passer à la suite du document assurez ­vous de bien avoir lu, la documentation concernant la configuration du service via extranet et munissez vous des paramètres de connexion utilisés pour vous connecter via notre extranet. Si jamais vos paramètres de connexion ne fonctionnaient pas, assurez vous auprès de votre commercial que l’API a été activé pour votre compte. Toutes les méthodes qui vont suivre retournent ‘OK’, dans le cas contraire le format des données retournées sera spécifié.

Dans la suite du document, nous commencerons par une présentation des différentes variables utilisées par l’API, suivie de la présentation des différentes méthodes disponibles. Chaque méthode sera suivi d’un exemple d’utilisation avec éventuellement le format des valeurs retournées, nous avons utilisé pour cela les cadres suivants :

Exemple     Valeur retournée

Haut de page

2. Les différentes variables utilisées par notre API

Variables Oblig. Valeurs Description Exemple
email oui   Votre identifiant sur notre extranet [email protected]
pass oui   Mot de passe sur notre extranet axialys
methode oui   Nom de l’action à effectuer appel_listing
sip non   Identifiant compte SIP 989959
client non a-zA-Z0-9_+ Nom du client dont vous souhaitez récupérer les statistiques MonCompte
date_debut oui YYYY-MM-DD Date de début des statistiques 2008-10-10
date_fin oui YYYY-MM-DD Date de fin des statistiques 2008-11-10
date   DD-MM-YYYY HH:ii:ss Date de l’appel 2008-11-10 10:20:30
Destination     Destination vers laquelle est passé l’appel au format e164 33820620620
Achat   0-9+(\.0-9+) Prix d’achat en euro HT 0.266
Vente   0-9+(\.0-9+) Prix de vente en euro HT 0.3
Marge   0-9+(\.0-9+) Marge en euro HT (différence entre le prix de vente et le prix d’achat) 0.1
Zone     Nom de la destination appelée France mobile

L’ensemble des variables suivantes seront envoyées via la méthode GET. L’url à utiliser sera : http://webservices.axialys.net/get/trunk/?   Notre serveur répondra immédiatement, en retournant le message ‘OK’, dans le cas où l’on attend une valeur de retour particulière, le format de la valeur de retour sera spécifié.

En cas de problème, paramètres manquants ou invalides… le message ‘NOK’ sera retourné suivi du détail de l’erreur.

Haut de page