API | Samabitik

Introduction

Bienvenue dans la documentation de l'API Samabitik. Notre API vous permet d'intégrer les fonctionnalités de Samabitik dans vos propres applications et services.

L'API Samabitik est organisée autour des principes REST. Elle utilise des méthodes HTTP standard, retourne des réponses JSON, et utilise des codes de statut HTTP pour indiquer les erreurs.

URL de base

Toutes les requêtes à l'API doivent être faites à l'URL de base suivante :

https://api.samabitik.com/v1

Versions

La version actuelle de l'API est v1. Nous vous recommandons de spécifier explicitement la version dans vos requêtes pour éviter des problèmes de compatibilité lors des mises à jour futures.

Authentification

L'API Samabitik utilise des clés API pour authentifier les requêtes. Vous pouvez obtenir votre clé API depuis votre tableau de bord Samabitik.

Toutes les requêtes à l'API doivent inclure votre clé API dans l'en-tête HTTP :

Authorization: Bearer YOUR_API_KEY

Exemple de requête avec authentification

curl -X GET "https://api.samabitik.com/v1/stores" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"
                            

Limites de requêtes

Pour assurer la stabilité du service, l'API Samabitik impose des limites de requêtes. Les limites varient selon votre forfait :

Forfait Starter : 100 requêtes par minute
Forfait Premium : 500 requêtes par minute
Forfait Business : 1000 requêtes par minute

Si vous dépassez ces limites, vous recevrez une réponse avec le code d'état HTTP 429 (Too Many Requests).

Les en-têtes suivants sont inclus dans toutes les réponses API pour vous aider à gérer vos limites :

X-RateLimit-Limit : Nombre maximum de requêtes autorisées par minute
X-RateLimit-Remaining : Nombre de requêtes restantes dans la période actuelle
X-RateLimit-Reset : Temps (en secondes) avant la réinitialisation du compteur

Gestion des erreurs

L'API Samabitik utilise les codes de statut HTTP conventionnels pour indiquer le succès ou l'échec d'une requête API. En général :

Les codes 2xx indiquent un succès
Les codes 4xx indiquent une erreur due à l'information fournie (par exemple, un paramètre manquant)
Les codes 5xx indiquent une erreur avec les serveurs Samabitik

Structure des erreurs

Lorsqu'une erreur se produit, l'API renvoie un objet JSON avec les propriétés suivantes :

{
  "error": {
    "code": "invalid_request",
    "message": "Description détaillée de l'erreur",
    "status": 400
  }
}
                            

Liste des boutiques

Récupère la liste des boutiques associées à votre compte.

GET

/stores

Paramètres de requête

Paramètre	Type	Description
limit	integer (optionnel)	Nombre maximum de boutiques à retourner. Par défaut : 20, Maximum : 100
offset	integer (optionnel)	Nombre de boutiques à sauter. Utilisé pour la pagination. Par défaut : 0

Exemple de réponse

{
  "data": [
    {
      "id": "store_123456",
      "name": "Ma Boutique",
      "url": "maboutique.samabitik.com",
      "created_at": "2025-01-15T12:00:00Z",
      "status": "active"
    },
    {
      "id": "store_789012",
      "name": "Ma Seconde Boutique",
      "url": "secondeboutique.samabitik.com",
      "created_at": "2025-03-20T15:30:00Z",
      "status": "active"
    }
  ],
  "meta": {
    "total": 2,
    "limit": 20,
    "offset": 0
  }
}
                            

Documentation API

Documentation