API Adresses

Endpoints pour la gestion des adresses des clients de votre application.

SDK: client.address

Endpoints

Lister les adresses

Liste toutes les adresses avec filtrage optionnel par client ou plateforme.


POST /app/{appId}/address/list

Requête

Champ	Type	Requis	Description
`apiKey`	string	Oui	Clé API
`customerId`	string	Non	Filtrer par ID client
`plateform`	string	Non	Filtrer par plateforme: `STORE`, `TRANSPORT`, `RESTAURATION`, `MULTI_SERVICE`, `E_LEARNING`


curl -X POST https://api.applite.ai/app/{appId}/address/list \
  -H "Content-Type: application/json" \
  -d '{
    "apiKey": "your_api_key",
    "customerId": "cust_123"
  }'

Réponse


{
  "success": true,
  "data": [
    {
      "id": "addr_123",
      "appId": "app_id",
      "customerId": "cust_123",
      "name": "Maison",
      "firstName": "Jean",
      "lastName": "Dupont",
      "phone": "+225070000000",
      "email": "jean@example.com",
      "address": "Rue des Fleurs 12",
      "address2": "Apt 4B",
      "city": "Abidjan",
      "zip": "01 BP 1234",
      "state": "Lagunes",
      "country": "CI",
      "longitude": -4.0083,
      "latitude": 5.3364,
      "plateform": "STORE",
      "createdAt": "2024-01-15T10:00:00.000Z",
      "updatedAt": "2024-01-15T10:00:00.000Z"
    }
  ]
}

Erreurs

Code	Description
`not-authorized`	Clé API invalide
`app-not-found`	Application non trouvée

Créer une adresse

Crée une nouvelle adresse pour un client.


POST /app/{appId}/address/create

Requête

Champ	Type	Requis	Description
`apiKey`	string	Oui	Clé API
`customerId`	string	Oui	ID du client
`name`	string	Oui	Nom de l’adresse (ex: “Maison”, “Bureau”)
`address`	string	Oui	Adresse principale
`firstName`	string	Non	Prénom
`lastName`	string	Non	Nom de famille
`phone`	string	Non	Numéro de téléphone
`email`	string	Non	Adresse email
`address2`	string	Non	Complément d’adresse
`city`	string	Non	Ville
`zip`	string	Non	Code postal
`state`	string	Non	État/Région
`country`	string	Non	Pays (code ISO)
`longitude`	number	Non	Longitude GPS
`latitude`	number	Non	Latitude GPS
`plateform`	string	Non	Type de plateforme


curl -X POST https://api.applite.ai/app/{appId}/address/create \
  -H "Content-Type: application/json" \
  -d '{
    "apiKey": "your_api_key",
    "customerId": "cust_123",
    "name": "Bureau",
    "address": "Avenue des Entreprises 45",
    "city": "Abidjan",
    "country": "CI",
    "longitude": -4.0083,
    "latitude": 5.3364
  }'

Réponse


{
  "success": true,
  "data": {
    "id": "addr_456",
    "appId": "app_id",
    "customerId": "cust_123",
    "name": "Bureau",
    "firstName": null,
    "lastName": null,
    "phone": null,
    "email": null,
    "address": "Avenue des Entreprises 45",
    "address2": null,
    "city": "Abidjan",
    "zip": null,
    "state": null,
    "country": "CI",
    "longitude": -4.0083,
    "latitude": 5.3364,
    "plateform": null,
    "createdAt": "2024-01-15T10:00:00.000Z",
    "updatedAt": "2024-01-15T10:00:00.000Z"
  }
}

Erreurs

Code	Description
`not-authorized`	Clé API invalide
`customer-not-found`	Client non trouvé
`invalid-request`	Paramètres manquants ou invalides

Mettre à jour une adresse

Met à jour les informations d’une adresse existante.


POST /app/{appId}/address/{id}/edit

Requête

Champ	Type	Requis	Description
`apiKey`	string	Oui	Clé API
`name`	string	Non	Nouveau nom de l’adresse
`firstName`	string	Non	Nouveau prénom
`lastName`	string	Non	Nouveau nom de famille
`phone`	string	Non	Nouveau téléphone
`email`	string	Non	Nouvel email
`address`	string	Non	Nouvelle adresse principale
`address2`	string	Non	Nouveau complément
`city`	string	Non	Nouvelle ville
`zip`	string	Non	Nouveau code postal
`state`	string	Non	Nouvel état/région
`country`	string	Non	Nouveau pays
`longitude`	number	Non	Nouvelle longitude
`latitude`	number	Non	Nouvelle latitude


curl -X POST https://api.applite.ai/app/{appId}/address/{addressId}/edit \
  -H "Content-Type: application/json" \
  -d '{
    "apiKey": "your_api_key",
    "name": "Nouveau Bureau",
    "address": "Boulevard Central 100"
  }'

Réponse


{
  "success": true,
  "data": {
    "id": "addr_456",
    "appId": "app_id",
    "customerId": "cust_123",
    "name": "Nouveau Bureau",
    "address": "Boulevard Central 100",
    "city": "Abidjan",
    "country": "CI",
    "updatedAt": "2024-01-20T14:30:00.000Z"
  }
}

Erreurs

Code	Description
`not-authorized`	Clé API invalide
`address-not-found`	Adresse non trouvée

Supprimer une adresse

Supprime une adresse.


POST /app/{appId}/address/{id}/delete

Requête

Champ	Type	Requis	Description
`apiKey`	string	Oui	Clé API


curl -X POST https://api.applite.ai/app/{appId}/address/{addressId}/delete \
  -H "Content-Type: application/json" \
  -d '{
    "apiKey": "your_api_key"
  }'

Réponse


{
  "success": true,
  "data": {
    "deleted": true
  }
}

Erreurs

Code	Description
`not-authorized`	Clé API invalide
`address-not-found`	Adresse non trouvée