Compte
- GET /v1/account - vérification de l'authentification, visualisation du niveau
- GET /v1/account/usage - utilisation pour la période en cours
- PUT /v1/account/webhook - définit l'URL du webhook + les événements
DÉVELOPPEURS - COLLECTION DE FACTEURS
Importer la collection. Atteindre le API en cinq minutes.
Collection Postman pré-construite avec des exemples travaillés pour chaque point de terminaison REST de Fabrixa. Introduisez votre clé API, cliquez sur les requêtes, voyez les réponses réelles par rapport au bac à sable avant d'écrire une seule ligne de code d'intégration. avant d'écrire une seule ligne de code d'intégration. Suivi des versions versions - la collection est mise à jour en même temps que le API.
POSTMAN v10+ - SANDBOX + PRODUCTION ENVS - MISE A JOUR A CHAQUE VERSION DE API
CE QU'IL Y A DANS LA COLLECTION
Chaque point d'extrémité, avec des exemples de charges utiles.
Organisé en dossiers par ressource : Compte, Produits, Commandes, Webhooks, Editor SDK. Chaque demande est accompagnée d'un exemple de corps travaillé, d'en-têtes prédéfinis et d'un exemple de réponse réussie sauvegardée. de réponse réussie sauvegardée - afin que vous puissiez prévisualiser la forme de la réponse avant de l'envoyer.
Produits
- GET /v1/produits - liste / pagination / filtre
- GET /v1/produits/:id - détail complet du produit
- GET /v1/produits/:id/pricing - aperçu du niveau de volume
Commandes
- PUBLIER /v1/orders - créer (avec clé d'idempotence)
- GET /v1/orders - liste / pagination
- GET /v1/orders/:id - statut, suivi, cycle de vie
- DEL /v1/orders/:id - annuler avant le verrouillage de la production
Crochets Web et SDK
- PUBLIER /v1/webhooks/test - déclencher un exemple d'événement
- GET /v1/webhooks/events - liste des types d'événements
- GET /v1/sdk/keys - clés SDK publiques et secrètes
IMPORTATION EN 30 SECONDES
Postman → Fichier → Importation → Lien → coller l'URL.
01
IMPORTER LA COLLECTION
Dans Postman : Fichier → Importation → Lien. Collez l'URL JSON à partir du bouton de téléchargement ci-dessus. Postman récupère et ajoute la collection à votre espace de travail.
02
IMPORTER L'ENVIRONNEMENT
Même flux, même URL de l'environnement : .../fabrixa-api.postman_environment.json. Définit l'échafaudage de variables (URL de base, espace réservé à la clé API).
03
DÉFINISSEZ VOTRE CLÉ API
Ouvrez l'environnement importé, remplissez CLÉ FABRIXA_API avec la clé de votre bac à sable. Passez à l'environnement de production lorsque vous êtes prêt à expédier.
VARIABLES D'ENVIRONNEMENT
Ce qui se trouve dans le fichier env.
fabrixa.postman_environment.json
# Environnement Sandbox { "FABRIXA_BASE_URL": "https://sandbox.api.fabrixa.com/v1", "FABRIXA_API_KEY": "sk_sandbox_yourKeyHere", "FABRIXA_PUBLIC_KEY": "pk_sandbox_votreCléPublique", "FABRIXA_WEBHOOK_URL": "https://your-tunnel.ngrok.io/webhook" } # Environnement de production (fichier séparé) { "FABRIXA_BASE_URL": "https://api.fabrixa.com/v1", "FABRIXA_API_KEY": "sk_live_yourKeyHere", "FABRIXA_PUBLIC_KEY": "pk_live_yourPublicKey", "FABRIXA_WEBHOOK_URL": "https://api.yourbrand.com/webhook" }
AUTHENTIFICATION PRÉCONFIGURÉE
Jeton de support appliqué au niveau de la collection.
La collection Autorisation est configuré pour hériter de la clé API de l'environnement actif. Chaque requête à l'intérieur de la collection la récupère automatiquement - pas de configuration d'en-tête par requête.
Pour passer du bac à sable à la production, il suffit de cliquer sur le menu déroulant de l'environnement. Même collection, clés différentes, URL de base différente. Aucun changement de code n'est nécessaire.
EXEMPLES CONCRETS
Chaque demande est accompagnée d'un exemple de corps et d'une réponse enregistrée.
La collection n'est pas seulement constituée d'URL de substitution - chaque demande est accompagnée d'un corps d'exemple travaillé afin que vous puissiez cliquer sur Envoyer et voir de vraies données. Les réponses des exemples sauvegardés sont visibles dans le panneau Exemples pour une référence hors ligne.
CREATE ORDER
POST /v1/commandes
Exemple de corps de texte pour une commande de deux t-shirts avec l'URL de l'œuvre d'art personnalisée, l'adresse du destinataire et la clé d'identification. Cliquez sur Envoyer pour voir une réponse 201 Created avec order_id.
LISTE DES PRODUITS
GET /v1/produits
Requête pré-filtrée pour la catégorie vêtements. Renvoie le catalogue page par page avec les tailles, le GSM, le délai de livraison et le niveau de prix par SKU.
DÉCLENCHER UN WEBHOOK
POST /v1/webhooks/test
Envoyez manuellement un exemple d'événement webhook à votre URL enregistrée. Utile pour déboguer les gestionnaires de webhook sans passer de commande réelle.
VÉRIFIER L'UTILISATION
GET /v1/compte/utilisation
Utilisation de la période de facturation en cours, état de progression des niveaux, volume prévu en fin de période. Utile pour planifier la capacité avant une forte baisse.
ANNULER LA COMMANDE
DELETE /v1/orders/:id
Annule une commande avant qu'elle ne bloque la production (généralement dans les 24 heures suivant la passation de la commande). Renvoie 409 si la production a déjà commencé - la clé d'idempotence gère les tentatives.
APERÇU DES PRIX
GET /v1/produits/:id/pricing
Prévisualisez le prix unitaire des différents niveaux de volume pour un SKU donné. Utile pour montrer aux clients les économies réalisées par unité lorsqu'ils augmentent la quantité commandée.
VERSIONNEMENT
La collection est mise à jour en même temps que le API.
Chaque version de Fabrixa API fournit une collection Postman mise à jour à la même URL. Réimporter pour récupérer les nouveaux points de terminaison et les exemples de charge utile - les requêtes existantes dans votre version sauvegardée restent fonctionnelles jusqu'à ce que le point d'accès soit obsolète.
01
URL STABLE
L'URL JSON de la collection est permanente. La réimportation permet d'obtenir la dernière version. L'URL ne change jamais entre les versions de API.
02
RÉFÉRENCE DU CHANGELOG
Voir Journal des modifications pour les notes de version correspondantes de API - ce qui a été déplacé, ce qui a été ajouté, ce qui est déprécié.
03
POLITIQUE DE DÉPRÉCIATION
Les terminaux bénéficient d'une fenêtre de dépréciation de 12 mois. La collection signale les requêtes dépréciées dans la description afin qu'il soit difficile de les manquer avant que les choses ne se cassent.
TÉLÉCHARGER ET DÉMARRER
Saisissez la collection. Lancez votre première demande.
Importer l'URL : https://www.fabrixa.com/wp-content/themes/brighthub-fabrixa/assets/downloads/fabrixa-api.postman_collection.json