REST API

L’API REST Applite vous permet d’interagir directement avec les services Applite via des requêtes HTTP. Tous les endpoints documentés ici sont ceux utilisés par les SDKs officiels (JavaScript et Dart).

Authentification

Toutes les requêtes API nécessitent deux paramètres d’authentification :

Ces paramètres sont passés dans le corps de la requête (body), pas dans les headers.

curl -X POST https://api.applite.ai/app/{appId}/customer/list \
  -H "Content-Type: application/json" \
  -d '{
    "apiKey": "votre_api_key"
  }'

Format des requêtes

Toutes les requêtes utilisent la méthode POST avec un corps JSON.

// Structure générale d'une requête
POST /app/{appId}/{module}/{action}
Content-Type: application/json
 
{
  "apiKey": "string",
  // ... autres paramètres
}

Format des réponses

Succès

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

Succès avec pagination

{
  "success": true,
  "data": [ ... ],
  "meta": {
    "total": 100,
    "page": 1,
    "limit": 20,
    "totalPages": 5
  }
}

Erreur

{
  "success": false,
  "error": "error-code"
}

Codes d’erreur courants

Modules disponibles

L’API est organisée en modules :

Gestion de l’application

• Clients - Gestion des clients
• Statistiques - Suivi des métriques
• Finance - Solde et transactions
• Welcome Items - Écrans d’accueil

Boutique (Store)

• Produits - Gestion des produits
• Catégories - Organisation des produits
• Commandes - Gestion des commandes
• Vendeurs - Gestion des vendeurs
• Badges - Badges produits
• Collections - Groupes de produits
• Réductions - Codes promo
• Options - Options de variantes
• Livraison - Profils de livraison
• Tags - Étiquettes
• Taxes - Configuration fiscale

Multi-Service

• Entreprises - Fournisseurs de services
• Services - Services proposés
• Agents - Personnel
• Rendez-vous - Gestion des RDV

Utilisation avec les SDKs

Chaque endpoint de cette API est accessible via les SDKs officiels :

import { AppliteUI } from "@applite/js-sdk";
 
const client = new AppliteUI({
  baseUrl: "https://api.applite.ai"
});
 
// Appel via SDK
const response = await client.app.customer.list({
  appId: "app_id",
  apiKey: "api_key"
});

import 'package:applite_ui/applite_ui.dart';
 
final client = AppliteUI(
  config: AppliteUIConfig(
    baseUrl: 'https://api.applite.ai',
  ),
);
 
// Appel via SDK
final response = await client.app.customer.list(
  appId: 'app_id',
  apiKey: 'api_key',
);