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

VariablesOblig.ValeursDescriptionExemple
emailoui Votre identifiant sur notre extranet[email protected]
passoui Mot de passe sur notre extranetaxialys
methodeoui Nom de l’action à effectuerappel_listing
sipnon Identifiant compte SIP989959
clientnona-zA-Z0-9_+Nom du client dont vous souhaitez récupérer les statistiquesMonCompte
date_debutouiYYYY-MM-DDDate de début des statistiques2008-10-10
date_finouiYYYY-MM-DDDate de fin des statistiques2008-11-10
date DD-MM-YYYY HH:ii:ssDate de l’appel2008-11-10 10:20:30
Destination  Destination vers laquelle est passé l’appel au format e16433820620620
Achat 0-9+(\.0-9+)Prix d’achat en euro HT0.266
Vente 0-9+(\.0-9+)Prix de vente en euro HT0.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éeFrance 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

3. Appels

Permet de récupérer les statistiques d'appels d'une journée :
  • Méthode : appel_listing, appels_in
  • Obligatoire : email, pass
  • Facultatif : sip, client

Exemple :

http://webservices.axialys.net/get/trunk/?methode=appels_listing&email=*&pass=&date_fin=2014-10-28&date_debut=2014-10-24

Cette méthode retourne les données suivantes :

Date;Client;Duree;Destination;Achat;Vente;Marge;Zone;Sip

Haut de page