Documentation API

L'API Shopflow.Pensée pour les développeurs.

Des API REST et GraphQL avec des URLs orientées ressource, des réponses JSON prévisibles et des codes HTTP standards.

Disponibilité 99,99 %

Sync temps réel

REST + GraphQL

shopflow-api ~

▌

URL de base

api.shopflow.io/v2

Auth

Bearer Token (JWT)

Limite

1 000 req/min

Versionnement

Basé URL /v2/

TLS

TLS 1.3 requis

Deux API. Une seule plateforme.

Utilisez REST pour la simplicité. GraphQL pour la précision. Combinez les deux librement.

REST

API REST

Des endpoints orientés ressources. Prévisible. Facile à déboguer. Parfait pour les intégrations serveur et les apps mobiles.

•Endpoint : api.shopflow.io/v2

•Format : JSON

•Auth : Bearer JWT

•Idempotence : prise en charge

•Pagination : basée sur curseur

Stable — v2.4

GraphQL

API GraphQL

Récupérez exactement ce dont vous avez besoin. Aucun surchargement. Idéal pour les vitrines headless et les requêtes complexes.

•Endpoint : api.shopflow.io/graphql

•Introspection : activée

•Subscriptions : temps réel (WS)

•Limite de profondeur : 10 niveaux

•Schéma : v3.2 — dernière version

Stable — v3.2

Premier appel API en 3 minutes

Aucun compte requis pour explorer. Utilisez des clés sk_test_ dans le bac à sable.

Étape 01

Récupérez votre clé API

# Dashboard → Settings → API Keys
SHOPFLOW_SECRET=sk_test_...

sk_test_ = sandbox. sk_live_ = production.

Étape 02

Installez le SDK

npm install @shopflow/node

Disponible aussi : pip, composer, gem

Étape 03

Faites votre premier appel

import Shopflow from '@shopflow/node';
const sf = new Shopflow({
  secretKey: process.env.SHOPFLOW_SECRET,
});
const products = await sf.products.list({const products = await sf.products.list({
  limit: 10,
  status: 'active',
});
console.log(products.data);

Récupérez la liste de vos produits en quelques secondes.

Fonctionne avec chaque stack

SDK officiels pour Node, Python, PHP, Ruby. REST brut et GraphQL pour tout le reste.

create-order.ts

import Shopflow from '@shopflow/node';

const sf = new Shopflow({
  secretKey: process.env.SHOPFLOW_SECRET,
  environment: 'production',
});

const order = await sf.orders.create({
  customer: {
    email: 'john@example.com',
    firstName: 'John',
    lastName: 'Doe',
  },
  lineItems: [
    {
      productId: 'prod_01HXYZ',
      variantId: 'var_01HABC',
      quantity: 2,
    },
  ],
  payment: {
    method: 'net_30',
    currency: 'CAD',
  },
});

// → { id: 'ord_01HXYZ', status: 'confirmed', total: 'CA$52.35' }

Réponse

{
  "id": "ord_01HXYZ789",
  "status": "confirmed",
  "total": {
    "amount": 5235,
    "currency": "CAD",
    "formatted": "CA$52.35"
  }
}

Vue d'ensemble de la référence API

Tous les endpoints. Toutes les méthodes. Une seule plateforme.

MÉTHODE	ENDPOINT	DESCRIPTION	AUTH	LIMITE
GET	/v2/products	Lister les produits	Requise	1000/min
GET	/v2/products/:id	Obtenir un produit	Requise	1000/min
POST	/v2/orders	Créer une commande	Requise	500/min
GET	/v2/orders/:id	Obtenir une commande	Requise	1000/min
PATCH	/v2/orders/:id	Mettre à jour une commande	Requise	500/min
POST	/v2/customers	Créer un client	Requise	500/min
GET	/v2/inventory	Vérifier le stock	Requise	2000/min
POST	/v2/webhooks	Enregistrer un webhook	Requise	100/min
DELETE	/v2/webhooks/:id	Supprimer un webhook	Requise	100/min

Commencez à construire aujourd'hui

Sandbox gratuit. Accès API complet. Aucune carte de crédit requise.

Sandbox gratuit à vie

REST + GraphQL

SLA de disponibilité 99,99 %

6 SDK officiels