Avant d’appeler l’API
Authentification
Vérifiez l’authentification.
Disponible à partir de
Vérifiez que le forfait de la boutique inclut la fonction API nécessaire.
Autorisations requises
Vérifiez les autorisations de la clé et les conditions liées aux champs envoyés.
Quel forfait choisir
| Disponible à partir de | Description |
|---|---|
| BASIC | BASIC comprend la lecture des commandes et des demandes clients, la modification de leurs statuts, du statut de paiement et du montant de remboursement enregistré. |
| STANDARD | Les opérations de catalogue, CMS, recherche et stock nécessitent STANDARD ou supérieur. |
Les boutiques déjà abonnées reçoivent les fonctionnalités API incluses dans leur forfait.
Autorisations d’une opération
- La référence indique required_scopes pour chaque opération et conditional_scopes pour certains champs ou changements protégés.
- Le droit de lecture n'accorde pas celui de créer, modifier ou supprimer.
- L'obtention du jeton et du contexte reste authentifiée même lorsqu'aucune autorisation de ressource n'est indiquée.
Lister
GET/api/v1/products
- Authentification
Bearer- Disponible à partir de
- STANDARD
- Autorisations requises
catalog.product:read
Modifier
PATCH/api/v1/products/{product_id}
- Authentification
Bearer- Disponible à partir de
- STANDARD
- Autorisations requises
catalog.product:update
Quand des autorisations supplémentaires sont nécessaires
Modifier
PATCH/api/v1/products/{product_id}
- Authentification
Bearer- Disponible à partir de
- STANDARD
- Autorisations requises
catalog.product:update- Autorisations supplémentaires pour certains champs
- Si variant_value_ids est fourni:
catalog.product_variant:create,catalog.product_variant:update,catalog.product_variant:delete - Si variants_enabled est fourni:
catalog.product_variant:update
- Si variant_value_ids est fourni:
Conséquences d’un changement de forfait
Lorsqu'une baisse de forfait retire une autorisation, elle est supprimée des clés API, décochée et désactivée dans l'administration.