API publique
Comprendre le modele CycleCore et integrer vos systemes externes.
API publique
L'API publique CycleCore permet a des systemes externes de lire et, a terme, de synchroniser les donnees catalogue d'une organisation: produits, familles, attributs, categories, medias et exports.
Cette documentation est destinee aux integrateurs externes: clients, agences, connecteurs Shopify ou Amazon, flux SFTP/CSV/XLSX, scripts internes et outils de reporting. Elle documente uniquement le contrat public stable. Les routes internes utilisees par l'application CycleCore ne font pas partie de cette API.
La V1 publique expose d'abord des routes de lecture sous
https://api.cyclecoreapp.com/public/v1. Les endpoints d'ecriture seront
ajoutes progressivement lorsqu'ils seront stabilises.
Principes
- Une cle API appartient a une organisation CycleCore.
- Chaque requete est automatiquement isolee sur cette organisation.
- Les droits sont limites par scopes, par exemple
products:read. - Le modele public est volontairement plus stable et plus restreint que le modele interne.
- Les donnees techniques internes, Prisma, permissions applicatives et routes d'administration ne sont jamais exposees comme contrat public.
Routes publiques V1 recommandees
Ces endpoints constituent la base de la future reference publique:
| Methode | Endpoint | Statut |
|---|---|---|
GET | /public/v1/products | Disponible |
GET | /public/v1/families | Disponible |
GET | /public/v1/attributes | Disponible |
GET | /public/v1/categories | Disponible |
GET | /public/v1/media | Disponible |
GET | /public/v1/products/{id} | A stabiliser |
POST | /public/v1/products | A stabiliser |
GET | /public/v1/channels | A stabiliser |
A ne pas exposer
Les routes suivantes doivent rester hors de la documentation publique:
- Routes d'identite, organisations, membres, roles et permissions.
- Routes de gestion des cles API utilisees par l'application CycleCore.
- Routes Stripe, facturation, checkout et webhooks internes.
- Routes Supabase exchange, onboarding, admin, notifications et dashboard.
- Routes d'import/export internes tant qu'un contrat public dedie n'existe pas.
- Routes de configuration connecteurs, OAuth, mapping ou synchronisation brute.
Prochaine lecture
Commencez par le demarrage rapide, puis consultez l'authentification et les concepts cles.