Authentification
Authentification par clé API et limites de débit
Authentification
Toutes les requêtes adressées à l’API Umbrella nécessitent une authentification. Deux méthodes existent, selon l’endpoint.
Authentification par en-têtes Shopify
Les endpoints publics (données des widgets, réclamations, recherche de polices) s’authentifient à l’aide d’en-têtes contenant le domaine de la boutique Shopify :
X-Shopify-Shop-Domain: your-store.myshopify.com
X-Shopify-Customer-Id: 1234567890Lorsque vous installez l’application Shopify Umbrella, le domaine de votre boutique est enregistré automatiquement. Aucune configuration manuelle n’est nécessaire pour les endpoints de la boutique.
Authentification par clé API interne
Les endpoints côté serveur (évaluation de l’éligibilité, synchronisation des produits) s’authentifient avec une clé API placée dans le corps de la requête :
{
"internalApiKey": "your-internal-api-key",
"orgId": "your-org-id"
}Pour générer ou renouveler une clé API interne :
- Accédez à Tableau de bord > Paramètres > Intégrations
- Repérez la section Clés API
- Cliquez sur Générer une nouvelle clé ou Renouveler la clé
Le renouvellement d’une clé invalide immédiatement la précédente. Mettez à jour toutes vos intégrations avant de la renouveler.
Environnements de test et de production
| Environnement | Domaine de la boutique | Comportement |
|---|---|---|
| Test | *.test, demo.myshopify.com, test.myshopify.com | Renvoie des données fictives, aucune transaction réelle |
| Production | Votre véritable domaine *.myshopify.com | Données réelles, transactions réelles |
Les requêtes en mode test renvoient "testingMode": true dans les réponses et utilisent des données de garantie d’exemple.
Gestion des erreurs
Codes d’erreur courants sur l’ensemble des endpoints :
| Statut | Signification |
|---|---|
400 | Paramètres manquants ou invalides |
401 | Aucun identifiant d’authentification fourni |
403 | Origine non autorisée ou clé API invalide |
404 | Ressource introuvable |
408 | Délai de requête dépassé (limite de 25 secondes) |
429 | Limite de débit dépassée — patientez puis réessayez |
500 | Erreur interne du serveur |
Lorsque vous recevez une réponse 429, attendez la fin du délai indiqué avant d’envoyer d’autres requêtes. Mettez en place un backoff exponentiel pour les scénarios à fort volume.
Voir aussi
- Vue d’ensemble des endpoints — Liste complète des endpoints disponibles
- API des garanties — Endpoints de gestion des plans de garantie
- Référence des Webhooks — Intégrations pilotées par les événements
