En développementBientôt disponible

Docs

REST API + MCP — tout documenté.

Spec OpenAPI 3.1, 16 outils, webhooks RGPD, limites par plan. La référence pour intégrer PackMate.

Spec OpenAPIDémarrage rapide
Démarrage rapide

Cinq minutes à la première requête

De l'install à votre premier appel API authentifié. Fonctionne pour REST et MCP.

  1. 1

    Installer PackMate sur Shopify

    Cliquez « Installer » sur l'App Store. PackMate fonctionne sur tout plan, vous pouvez démarrer en Free.

  2. 2

    Générer une clé API

    Réglages → API & MCP → Générer. Préfixe pm_live_ ou pm_test_ pour sandbox.

    pm_live_4f3a8b9c2d1e...
  3. 3

    Première requête

    Utilisez curl ou un client HTTP. Le header X-API-Key authentifie chaque requête.

    curl https://packmate.shop/api/v1/health \
  -H 'X-API-Key: pm_live_…'
  4. 4

    Suivant : MCP

    Pour l'IA, la même clé fonctionne pour le serveur MCP. Voir /ai pour Claude / ChatGPT.

Authentification

Clés API, scopes, rotation

PackMate utilise des clés API avec le header X-API-Key. Hashées SHA-256, scopées au shop, rotation en un clic.

Format de clé

Deux préfixes : pm_live_ pour la prod, pm_test_ pour sandbox. Body 32 caractères base62.

pm_live_4f3a8b9c2d1e7f6a5b4c3d2e1f0a9b8c

Format header

Envoyez la clé dans X-API-Key. Bearer dans Authorization aussi accepté.

X-API-Key: pm_live_…
# ou
Authorization: Bearer pm_live_…

Rotation

Générez nouvelle clé, échangez, révoquez l'ancienne. Jusqu'à 5 clés actives par shop.

DELETE /api/v1/keys/:key_id
Response: 204 No Content

Scopes

Clés full read+write par défaut. Scoped keys (read-only, label-only) sur la roadmap.

scope: read_only | label_only | full
Limites de taux

Les limites évoluent avec votre plan

Limites par minute et burst. Bursts lissés par token bucket. Plans Custom négocient.

PlanReq / minBurstConcurrent
Free601205
Basic12024010
Pro30060025
Business600120050
Customneg.neg.neg.
Glissez pour voir plus

Au limite, vous obtenez 429 avec header Retry-After. Le header indique combien de secondes attendre.

Codes d'erreur

Ce que ça signifie quand ça échoue

Sémantique HTTP standard avec corps d'erreur PackMate. Chaque erreur inclut un code machine et un message.

CodeSignificationAction
400
Bad request — corps ou query mal forméVérifiez la forme de la requête contre la spec OpenAPI.
401
Non autorisé — clé API manquante ou invalideEnvoyez le header X-API-Key avec une clé pm_live_ valide.
402
Paiement requis — plafond atteintUpgradez ou attendez le prochain cycle. Bulk-Reconciliation après upgrade.
403
Interdit — fonctionnalité hors planSeul query_carrier_rates est plan-gated (Custom uniquement).
404
Non trouvé — ressource inexistanteVérifiez l'ID. Pour les commandes, peut-être pas encore syncée.
422
Non traitable — validation sémantique échouéeLisez error.message — typiquement dimensions manquantes.
429
Trop de requêtes — limite atteinteBack-off via header Retry-After.
500
Erreur interne — bug de notre côtéRetry une fois, puis email à support@packmate.shop avec request_id.
503
Service indisponible — maintenance ou souci DBRetry avec backoff exponentiel. Status sur status.packmate.shop.
Glissez pour voir plus
Erreur client (4xx)Erreur serveur (5xx)
Webhooks

RGPD + cycle de vie webhooks

PackMate enregistre six webhooks Shopify. Quatre RGPD-obligatoires, deux opérationnels. Signés HMAC-SHA256.

customers/redactRequis

Client demande suppression. PackMate anonymise sous 30 jours.

customers/data_requestRequis

Client demande export. PackMate compile sous 30 jours.

shop/redactRequis

Shopify l'envoie environ 48 heures après la désinstallation. PackMate supprime alors toutes les données de la boutique de sa base de données.

app/uninstalledRequis

L'application a été désinstallée. PackMate marque la boutique comme désinstallée, révoque ses clés API et met fin à l'abonnement. Les données sont supprimées avec shop/redact.

products/updateOptionnel

Produit changé — PackMate rafraîchit les dimensions cachées.

app/scopes_updateOptionnel

Scopes changés — PackMate demande ré-autorisation.

Tous les webhooks signés HMAC-SHA256 avec votre app secret. Vérifiez X-Shopify-Hmac-SHA256.

Prêt à intégrer ? Générez une clé.

Installez, générez une clé, lancez votre première requête — en moins de cinq minutes.

Get early accessGuide MCP