Documentation API

Bienvenue dans la documentation de l'API Pharmacie de Garde Maroua. Cette API RESTful vous permet d'accéder aux données des pharmacies de garde, aux horaires et aux évaluations.

URL de base


                                    https://pharmacies.maroua-it.cloud/api

Format de réponse

Toutes les réponses sont au format JSON avec l'en-tête Content-Type: application/json

Démarrage rapide

Suivez ces étapes simples pour commencer à utiliser l'API Pharmacie de Garde Maroua.

1

Créez votre compte

Inscrivez-vous gratuitement et recevez 10 tokens API gratuits pour commencer à tester l'API immédiatement.

Créer un compte

2

Obtenez vos clés API

Après inscription, accédez à votre dashboard pour voir votre clé API générée automatiquement. Vous pouvez créer plusieurs clés selon vos besoins.

Exemple de clé API :


                                        pg_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0

3

Utilisez votre clé API

Ajoutez votre clé API dans l'en-tête X-API-Key ou en paramètre de requête.

Méthode 1 : En-tête HTTP (Recommandé)

curl -X GET "https://pharmacies.maroua-it.cloud/api/pharmacies" \
  -H "X-API-Key: votre_cle_api_ici"

Méthode 2 : Paramètre de requête

curl "https://pharmacies.maroua-it.cloud/api/pharmacies?api_key=votre_cle_api_ici"

Plans tarifaires

Gratuit: 10 tokens pour découvrir l'API
100 Tokens: 1,000 FCFA - Parfait pour les petits projets
Illimité: 15,000 FCFA/an - Appels illimités pour un an

Voir les tarifs complets

Authentification API

Tous les endpoints de pharmacies, horaires et évaluations nécessitent une clé API valide. Les clés API sont liées à votre compte et chaque appel consomme 1 token.

En-têtes de réponse

Chaque réponse API inclut des informations sur votre utilisation :

X-RateLimit-Remaining: 95
X-RateLimit-Type: FREE

🔒 Endpoints protégés

Tous les endpoints liés aux pharmacies, horaires et évaluations nécessitent une clé API. Seuls les endpoints d'authentification (/api/auth/*) sont publics.

Pharmacies

GET /api/pharmacies

Récupère la liste de toutes les pharmacies disponibles.

Réponse

{
  "success": true,
  "data": [
    {
      "id": 1,
      "name": "Pharmacie Centrale",
      "address": "Avenue Hassan II",
      "phone": "+237 699 99 99 99",
      "latitude": 10.5897,
      "longitude": 14.3154,
      "district": "Domayo",
      "is_active": true,
      "is_24_hours": false,
      "average_rating": 4.5,
      "ratings_count": 12
    }
  ]
}

GET /api/pharmacies/on-duty

Récupère uniquement les pharmacies de garde actuellement ouvertes.

GET /api/pharmacies/nearby

Trouve les pharmacies à proximité d'une position GPS donnée.

Paramètres (Query)

latitude Latitude (requis) - Type: float

longitude Longitude (requis) - Type: float

radius Rayon en km (optionnel, défaut: 10) - Type: integer

Exemple de requête

GET /api/pharmacies/nearby?latitude=10.5897&longitude=14.3154&radius=5

GET /api/pharmacies/{id}

Récupère les détails complets d'une pharmacie spécifique par son ID.

Horaires de Garde

GET /api/schedules/day/{date}

Récupère les pharmacies de garde pour un jour spécifique.

Exemple

GET /api/schedules/day/2025-12-01

GET /api/schedules/week/{date}

Récupère les pharmacies de garde pour toute la semaine contenant la date spécifiée.

GET /api/schedules/month/{year}/{month}

Récupère toutes les pharmacies de garde pour un mois spécifique.

Exemple

GET /api/schedules/month/2025/12

Évaluations

GET /api/pharmacies/{id}/ratings

Récupère toutes les évaluations d'une pharmacie spécifique.

POST /api/pharmacies/{id}/ratings Auth

Ajoute une nouvelle évaluation pour une pharmacie. Nécessite une authentification.

Corps de la requête (JSON)

{
  "rating": 5,
  "comment": "Excellent service et accueil chaleureux!"
}

Validation

rating - Requis, entier entre 1 et 5
comment - Optionnel, chaîne de caractères

Codes d'erreur

Code	Signification
`200`	OK - Requête réussie
`400`	Bad Request - Paramètres invalides
`401`	Unauthorized - Authentification requise
`404`	Not Found - Ressource introuvable
`429`	TOKENS_DEPLETED - Tu as dépassé la limite d’appels autorisés à ton API.
`500`	Internal Server Error - Erreur serveur