Menu

Documentation API

Documentation structuree pour l'API d'integration conciergerie.

Authentification

L'acces API est prive et necessite des identifiants approuves. Les cles API admin permettent d'obtenir plus de champs sur les endpoints /api/concierges.

Demander un acces API

L'acces public est desactive pour le moment. Contactez-nous pour obtenir des identifiants.

Envoyer un email a contact@airconcierge.io

Endpoints

GET/api

Docs localisee dans le navigateur, index JSON avec ?format=json.

Acces prive requis.

Parametres

  • format=json (optionnel, force la reponse index JSON)

Format de reponse

Redirection docs (navigateur) ou reponse index JSON.

GET/api/concierges

Recherche et pagination des conciergeries.

Acces prive requis.

Parametres

  • q, location, services
  • limit (max 50), offset
  • lang (en | fr)
  • view=admin (optionnel, necessite une cle API admin)

Format de reponse

Reponse liste avec data[], pagination, language. Cle admin + view=admin retourne tous les champs de la conciergerie.

GET/api/concierges/{id}

Recupere une conciergerie via ObjectId MongoDB.

Acces prive requis.

Parametres

  • id (path)
  • lang (en | fr)
  • view=admin (optionnel, necessite une cle API admin)

Format de reponse

Reponse detail avec data, language. Cle admin + view=admin retourne tous les champs de la conciergerie.

OpenAPI

Specification OpenAPI 3.1 lisible par machine pour partenaires approuves.

Ouvrir l'endpoint OpenAPI

Format de reponse

{
  "data": [
    {
      "id": "65a12bc34de56f7890abc123",
      "businessName": "Example Concierge",
      "location": ["Paris"],
      "services": ["Check-in", "Cleaning"],
      "website": "https://example.com",
      "description": "Short public profile",
      "rating": 4.9,
      "reviewCount": 84,
      "commissionRateMin": 18,
      "commissionRateMax": 24
    }
  ],
  "pagination": {
    "limit": 20,
    "offset": 0,
    "returned": 1,
    "total": 1,
    "hasMore": false
  },
  "language": "fr"
}