Reference · Getting Started
Démarrage
Bienvenue dans l'API Oolel Maps. Ce guide vous accompagne pour créer votre compte, obtenir une clé API et effectuer votre première requête.
Vue d'ensemble
Oolel Maps fournit une API REST pour le géocodage, la recherche et la navigation en Afrique de l'Ouest. Tous les endpoints se trouvent sous le préfixe /api/v1, renvoient du JSON et supportent le français, l'arabe et l'anglais via un paramètre de langue.
URL de base
https://api.oolelmaps.com/api/v1Créez votre compte
Rendez-vous sur la page d'inscription et créez un compte développeur gratuit. Vous devrez fournir votre adresse e-mail, un mot de passe et éventuellement le nom de votre société.
Générez une clé API
Après connexion, allez dans la section Clés API de votre tableau de bord. Cliquez sur « Créer une nouvelle clé » et donnez-lui un nom descriptif (par ex. « Production » ou « Développement »). Copiez et stockez votre clé en lieu sûr — elle ne sera plus affichée après sa création.
Effectuez votre première requête
Utilisez votre clé API dans l'en-tête Authorization avec le préfixe Bearer. Voici un exemple simple de géocodage avant :
curl -X GET "https://api.oolelmaps.com/api/v1/geocode/forward?address=Tevragh+Zeina+Nouakchott" \
-H "Authorization: Bearer YOUR_API_KEY"Authentification
Toutes les requêtes API doivent inclure votre clé dans l'en-tête Authorization :
Authorization: Bearer YOUR_API_KEYLes requêtes sans clé API valide reçoivent une réponse 401 Unauthorized.
Limites de débit
Chaque clé API est soumise à un throttling global pour éviter les abus. Si vous dépassez la limite, l'API répond avec 429 Too Many Requests. Contactez le support si votre charge de production nécessite un débit plus élevé.
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 97
X-RateLimit-Reset: 1709683200Gestion des erreurs
L'API utilise les codes HTTP standards. Les réponses d'erreur incluent un corps JSON avec un message descriptif :
{
"statusCode": 400,
"message": "Query parameter 'address' is required",
"error": "Bad Request"
}| Code | Description |
|---|---|
200 | Requête réussie |
400 | Requête incorrecte (paramètres manquants ou invalides) |
401 | Non autorisé (clé API manquante ou invalide) |
429 | Limite de débit dépassée |
500 | Erreur interne du serveur |
Support multilingue
La plupart des endpoints acceptent un paramètre language pour contrôler la langue de la réponse. Valeurs supportées :
frFrançais (par défaut)
arArabe
enAnglais