Vous êtes sur la page 1sur 9

location API

géolocalisez des mobiles

description documentation tarifs activer

description Télécharger la fiche produit

Location API
En bref après acceptation de son
propriétaire, localisez son
mobile* et récupérez ses
coordonnées
Difficulté 1/5
Temps 15 minutes
d'apprentissage
Type de requête HTTPs (REST – RPC)
Gamme Mobile
Price: crédits de test gratuits à
l’inscription
prix par requête de localisation
Grille tarifaire >

L’API Location permet de localiser l'emplacement géographique d'un utilisateur mobile* depuis votre
application
 l'autorisation du propriétaire est nécessaire pour toute géolocalisation
 cette API fonctionne avec n'importe quel téléphone mobile
 cette API retourne les coordonnées GPS du mobile
Organisation d'évènements en temps réel, rencontres, assistance en cas de problèmes, améliorez la
performance de vos services grâce à cet outil simple et fiable
Cette API est ouverte à tout développeur
*Actuellement, le service est disponible pour les mobiles du réseau Orange France (opérateurs partenaires
inclus). Une évolution permettra d’offrir une disponibilité multi opérateur

1. testez !

2. quelle application ?

1. testez !
Saisissez votre numéro de téléphone dans l'application ci-dessous et cliquez sur localisez-moi
répondez aux 2 SMS du processus d'autorisation
Vous serez immédiatement localisé sur une carte.
NB: envoyer "non demo" au 20345 à la fin de ce test afin qu'orange supprime votre autorisation de géolocalisation
2. quelle application ?
 localisez les restaurants proches de plusieurs utilisateurs

 géolocalisez vos proches

 suivez votre flotte de véhicules

Découvrez une liste plus complète des applications possibles

Toutes les combinaisons de nos API sont possibles : inspirez-vous de la rubrique mash-up
location API
géolocalisez des mobiles

description documentation tarifs activer

documentation Télécharger la fiche produit

L'API Location est un service Web permettant de localiser des


mobiles
Ce service Web présente une interface de style REST-RPC
Les requêtes peuvent utiliser les méthodes GET et POST en mode
HTTP ou HTTPS

L'utilisation de l'API location se fait en 2 étapes :

 l'autorisation (pour votre service et pour la plateforme)


 la localisation proprement dite

1. méthodes
a. createAuthorization: récupérez l'autorisation de l'usager afin de le localiser
b. getLocation: localiser un mobile
2. exemple de code

1. méthode
a. createAuthorization
La méthode createAuthorization permet de
demander à l'utilisateur mobile* s'il autorise votre
application à accéder à sa localisation
*Actuellement, le service est disponible pour les mobiles
du réseau Orange France (opérateurs partenaires
inclus). Une évolution permettra d’offrir une disponibilité
multi opérateur

Le processus d'autorisation se fait en 2 SMS :


1. "oui <nom du service>" vers le 20345 = autorisation du mobile pour ce service
2. "oui location" vers le 20633 = autorisation du mobile à la plateforme orange
NB : si l'utilisateur souhaite se désabonner de votre service, il lui suffit d'envoyer "non <nomduservice>" au 20345

Requête
http://location.beta.orange-api.net/location/createAuthorization.xml?id=[votre
API Access Key]&number=[numéro du mobile à autoriser]
NB : le détail de tous les paramètres est disponible en élargissant la zone ci-dessous

Paramètre de la description
requête
id type : string champ : obligatoire
API Access Key est votre identifiant personnel lors de l’usage d’une API. L’API
Access Key est disponible dans la rubrique mon compte
number type : string champ : obligatoire
Numéro de mobile à autoriser
Ce numéro doit être au format international
par ex : 3312345678 (France).

Réponse :
<?xml version="1.0" encoding="UTF-8"?>
<response>
<status>
<status_code>200</status_code>
<status_msg>OK</status_msg>
</status>
<call_info>
<call_id>3DhG5wUla1nVtWArwKm2</call_id>
</call_info>
<data></data>
</response>
NB : le détail de tous les paramètres est disponible en élargissant la zone ci-dessous

Paramètre de la Description
réponse
<status_code> type : integer
code de statut de la réponse (voir tableau ci-dessous)
<status_message> type : string
message de statut de la réponse

Code message
200 ok
(ok)

400 id is missing
(Identifiant manquant)
401 unauthorized id
(identifiant non autorisé)

402 insufficient credit


(crédit insuffisant )
403 banned id
(identifiant interdit)
420 over daily quota
(quota journalier dépassé)
430 parameter number is missing
(paramètre numéro manquant)
431 parameter precision is missing
(paramètre precisision manquant)
440 parameter number is invalid
(paramètre numéro erroné)

441 parameter precision is invalid


(paramètre precision erroné)

phone unavailable, retry later


443
(téléphone injoignable, réessayez plus tard)
unauthorized phone number
450
(numéro de téléphone non autorisé)

pending authorization
451
(autorisation en attente)

location refused, not authorized


452
(localisation refusée, non autorisée)
phone is not reachable, try later
453 (téléphone non joignable, réessayer plus tard quota de
demandes)
quotas d'autorisation dépassé pour ce numéro

500 internal error


(erreur interne)
<call_id> type : string
Identifiant unique d’appel d’API

b. getLocation
La méthode getLocation retourne les coordonnées
GPS du mobile*
*Actuellement, le service est disponible pour les mobiles
du réseau Orange France (opérateurs partenaires
inclus). Une évolution permettra d’offrir une disponibilité
multi opérateur

Requête
http://location.beta.orange-api.net/location/getLocation.xml?id[votre API Access
Key]&number=[numéro du mobile à localiser]
NB : le détail de tous les paramètres est disponible en élargissant la zone ci-dessous

Paramètre de la description
requête
id type : string champ : obligatoire
API Access Key est votre identifiant personnel lors de l’usage d’une API. L’API
Access Key est disponible dans la rubrique mon compte
number type : string champ : obligatoire
Numéro de mobile à localiser au format international
par ex : 3312345678 (France)

Réponse :
<?xml version="1.0" encoding="UTF-8" ?>
<response>
<status>
<status_code>200</status_code>
<status_msg>OK</status_msg>
</status>
<location>
<time>2008-05-06T14:51:36Z+0200</time>
<number>33123456789</number>
<X>+48.788056</X>
<Y>+2.051111</Y>
<radius>1033</radius>
</location>
<call_info>
<call_id>3DhG5wUla1nVtWArwKm2</call_id>
</call_info>
<data></data>
</response>
NB : le détail de tous les paramètres est disponible en élargissant la zone ci-dessous

Paramètre de la Description
réponse
<status_code> type : integer
code de statut de la réponse (voir tableau ci-dessous)
<status_message> type : string
message de statut de la réponse
Code message

200 ok
(ok)
(Identifiant manquant)

401 unauthorized id
(identifiant non autorisé)

402 insufficient credit


(crédit insuffisant )

403 banned id
(identifiant interdit)
420 over daily quota
(quota journalier dépassé)

430 parameter number is missing


(paramètre numéro manquant)
431 parameter precision is missing
(paramètre precisision manquant)
440 parameter number is invalid
(paramètre numéro erroné)
441 parameter precision is invalid
(paramètre precision erroné)

phone unavailable, retry later


443
(téléphone injoignable, réessayez plus tard)
unauthorized phone number
450
(numéro de téléphone non autorisé)
pending authorization
451
(autorisation en attente)

location refused, not authorized


452
(localisation refusée, non autorisée)

phone is not reachable, try later


453 (téléphone non joignable, réessayer plus tard quota de
demandes)

(authorization quotas exceeded for this number)


454
quotas d'autorisation dépassé pour ce numéro

500 internal error


(erreur interne)
<time> type : date
Le moment où les données de localisation ont été obtenues.
L'heure est affichée au format ci-dessous:
e.g. JJ-MMAAAAHH:MM:SSZ
<number> type : string
Le numéro de mobile localisé
<X> type : string
La latitude (en degrés) affichée dans le système de coordonnées WGS84
<Y> type : string
La longitude (en degrés) affichée dans le système de coordonnées WGS84
<radius> type : integer
Le rayon de la cellule (en mètres)
<call_id> type : string
Identifiant unique d’appel d’API

2. exemple de code

envoyer un SMS en quelques lignes de code !


1. copiez/collez ce code dans un fichier PHP.
2. remplissez les paramètres ACCESS KEY, FROM, TO et CONTENT.
3. télécharger le fichier sur votre serveur Web.
4. exécutez votre page.
<?php

// votre API Access Key


$access_key = "XXXXXXX";

// adresse de l'API sendSMS


$adresse = "http://sms.beta.orange-api.net/sms/sendSMS.xml";
// shortcode d'émission : 23045 (Orange France), 38100 (Multi-opérateur
France), 967482 (Orange UK) ou +447797805210 (international)
$from = "38100";
// numéro de téléphone du destinataire (au format international)
$to = "336XXXXXXXX";
// contenu du SMS (limité à 160 caractères)
$content = urlencode(substr("votre contenu ici !", 0, 159));

// éxécution de la requête > envoi du SMS


$fd = file_get_contents($adresse . "?id=" . $access_key . "&from=" . $from .
"&to=" . $to . "&content=" . $content);

// Affichage de la réponse de l'API


$xml=simplexml_load_string($fd);
echo($xml->status->status_code . " - " . $xml->status->status_msg);

?>
location API
géolocalisez des mobiles

description documentation tarifs activer

tarifs Télécharger la fiche produit

Principes de facturation de l’API Location :

 facturation à la requête
 facturation par méthode utilisée
 discount au volume
NB: *Actuellement, le service est disponible pour les mobiles du
réseau Orange France (MVNO inclus). Une évolution permettra
d’offrir une disponibilité multi opérateur

NB: l'usage des orange APIs se fait à l'aide de crédits. Les crédits sont
communs à toutes les API. Chaque crédit vaut 1 cts€ TTC.

tarifs (cts€/requête) (HT)

pack nombre de Localiser la première fois * Localiser Discount


crédits
10 € 1 000 9,20 8,36 -
50 € 5 350 9,11 8,27 7%
100 € 11 000 9,07 8,24 10%
500 € 56 000 9,05 8,21 12%

1 000 € 113 000 9,03 cts€/requête 8,20 cts€/requête 13%

* NB: tarifs hors taxe appliqués à la première demande de localisation d'un nouveau mobile sur votre service

1. grille tarifaire
a. localiser la première fois : createAuthorization
b. localisez un mobile : getLocation

1. grille tarifaire

a. localiser la première fois : createAuthorization


Principe de facturation :

 facturation à la requête pour l'autorisation de localisation de l'usager (voir grille tarifaire ci-dessous)
 plus facturation à la requête la localisation du mobile (voir grille tarifaire "b. getLocation")
* NB: *Actuellement, le service est disponible pour les mobiles du réseau Orange France (MVNO inclus).
Une évolution permettra d’offrir une disponibilité multi opérateur

Exemple de facturation :
 Lorsqu'une requête createAuthorization est envoyée à un abonné mobile qui n'a jamais été
abonné au service de géolocalisation:

 Le développeur paye 0,84 cts€ HT par requête pour l'autorisation


 Le développeur paye ensuite 8,4 cts€ HT par requête de localisation
 Lorsqu'une requête createAuthorization est envoyée à un abonné mobile est déjà abonné au
service de géolocalisation:
 Gratuit
Tarifs :

tarif
tarif (cts€/requête)
Pays opérateur (crédits/requête)
(HT)
(HT)

France orange France 0,84 0,84

b. localisez un mobile : getLocation


Principe de facturation :

 facturation à la requête
 un discount au volume est appliqué
* NB: *Actuellement, le service est disponible pour les mobiles du réseau Orange France (MVNO inclus).
Une évolution permettra d’offrir une disponibilité multi opérateur

Exemple de facturation :

 Lorsqu'une requête getLocation est envoyée:


 Le développeur paye 8,4 cts€ HT par requête
Tarifs :

tarif
tarif (cts€/requête)
Pays opérateur (crédits/requête)
(HT)
(HT)
France orange France 8,4 8,4