API publiques

Présentation de l'API publique : ses possibilités, l'authentification et les limites de débit.

1. Périmètre d’utilisation de l’API

a. Fonctionnalités prises en charge par l’API

L’API publique permet d’interagir avec les principales fonctionnalités de l’application Wholesale, notamment :

Fonctionnalités principales : Wholesale Pricing, Volume Pricing, Registration form, Quick Order Form, Quick Buy Collection, Quick Buy Variant
Fonctionnalités complémentaires : Order Limit, Shipping Rate, Extra Fee, Payment Term (bientôt disponible)

b. Méthodes prises en charge

L’API prend en charge toutes les opérations CRUD avec les méthodes HTTP suivantes :

GET – Récupérer des données
POST – Créer de nouvelles données
PUT – Mettre à jour des données existantes
DELETE – Supprimer des données

Les clés API peuvent recevoir les niveaux d’autorisation suivants : Read Only/Write Only, Read & Write

Actions prises en charge : Get list - Get item - Create item - Update item - Delete item

c. Forfaits Shopify pris en charge :

L’API publique de l’application Wholesale est disponible pour les boutiques Shopify qui remplissent les conditions suivantes :

Être une boutique de production (non disponible pour les boutiques de développement ou de test)
Être abonnée au forfait Gold

2. Authentification

Toutes les requêtes API doivent être correctement authentifiées avant d’être traitées.

a. Paramètres obligatoires

Chaque requête API doit inclure les paramètres obligatoires suivants :

Paramètre	Description
`shop`	Domaine de la boutique Shopify (p. ex. mystore.myshopify.com)
`api_key`	Clé API générée depuis l’application Wholesale

Si l’un de ces paramètres est manquant, la requête est rejetée.

b. Gestion des clés API

Les clés API sont créées et gérées directement dans l’interface d’administration de l’application Wholesale.
Vous pouvez configurer des autorisations spécifiques pour chaque clé API : Read only/Write only, Read & Write

3. Structure de l’API et format des réponses

a. Point de terminaison de l’API

Toutes les requêtes API doivent utiliser l’URL de base suivante :

https://wholesale.samita.io/v1/

b. Points de terminaison par fonctionnalité

Chaque groupe de fonctionnalités dispose de son propre point de terminaison. Par exemple :

Fonctionnalité Wholesale :

https://wholesale.samita.io/v1/wholesale/

Fonctionnalité Volume Pricing :
```
https://wholesale.samita.io/v1/volume/
```

(Les points de terminaison réels peuvent varier selon la fonctionnalité concernée.)

c. Paramètres de requête pris en charge

L’API prend en charge plusieurs paramètres de requête courants :

Paramètre	Description
`status`	Statut des enregistrements
`page`	Numéro de page pour la pagination
`limit`	Nombre d’enregistrements par page
`sort`	Critère de tri
`query`	Condition de recherche ou de filtre

Exemple de requête :

GET /wholesale?page=1&limit=20&sort=created_at

4. Codes de réponse

Chaque requête API renvoie l’un des codes d’état suivants :

a. Réponses d’erreur courantes

401 – Non autorisé

Causes possibles :

URL de la boutique manquante
Clé API manquante
URL de la boutique non valide
Clé API non valide
La clé API ne correspond pas à la boutique

403 – Cette action n’est pas autorisée

La clé API n’a pas l’autorisation d’effectuer l’action demandée
Autorisations insuffisantes pour View / Create / Update / Delete

429 – Trop de requêtes

La limite de requêtes a été dépassée
La fréquence des appels API dépasse la limite de débit autorisée

b. Réponse de succès

200 – Succès

La requête est valide
L’action de l’API a été exécutée avec succès
Les données sont renvoyées au format attendu

5. Limite de débit

Pour garantir les performances et la stabilité du système, l’utilisation de l’API est soumise à une limite quotidienne de requêtes. Il n’y a plus de limitation par requête ni sur de courts intervalles : vous pouvez appeler l’API aussi souvent que nécessaire tant que vous restez dans le quota quotidien de votre forfait.

La limite quotidienne dépend du forfait de la boutique :

Forfait	Limite quotidienne de requêtes
Free	5 requêtes/jour
Starter	50 requêtes/jour
Growth	250 requêtes/jour
Enterprise	500 requêtes/jour

Le compteur quotidien est réinitialisé chaque jour à minuit (heure du serveur).

Si la limite quotidienne est dépassée, le système renvoie :

429 – Too Many Requests

{
  "message": "Daily request limit exceeded (X requests/day)."
}

Cette page vous a-t-elle été utile ?