YAOKA DevelopersYAOKA Developers
business-api/YAOKA Business API

YAOKA Business API

Référence technique des fonctions de gestion commerciale réellement disponibles dans YAOKA Business.

YAOKA Business fournit un moteur de gestion commerciale pour créer des clients, devis, factures et avoirs, générer les PDF officiels et suivre leur cycle de vie. Cette documentation distingue explicitement les endpoints publics des fonctions disponibles uniquement dans l’application YAOKA Business.

Le programme RFE partenaire est en pause. Aucun endpoint décrit ici ne doit être présenté comme une transmission réglementaire via une plateforme agréée.

URL de base

Sandbox et production utilisent la même infrastructure :

https://api.yaoka.fr/api/v1
  • Une clé client sk_org_... est limitée à sa propre organisation.
  • Une clé partenaire ypk_test_... est limitée à l’organisation sandbox attribuée.
  • Une clé partenaire ypk_live_... est limitée aux organisations clientes autorisées.
  • Pour un partenaire, le passage en production change la clé et X-Yaoka-Organization-Id, jamais l’URL.

Parcours de vente disponible

Organisation → Client → Devis brouillon → Devis finalisé
             → Acceptation → Conversion → Facture brouillon
             → Facture finalisée → Paiement ou Avoir
DomaineDisponibilité API publique
OrganisationsDisponible
ClientsDisponible
Devis et PDFDisponible
Factures clients et PDFDisponible
AvoirsDisponible
Webhooks de venteDisponible
ProduitsUtilisables par productId, gestion publique non exposée
FournisseursYAOKA Business uniquement
Factures fournisseursYAOKA Business uniquement
Notes de frais et rapprochement bancaireYAOKA Business uniquement
Transmission RFE et réception réglementaireEn pause

Consultez la page Disponibilité avant de concevoir une intégration.

Premier appel

curl https://api.yaoka.fr/api/v1/organizations \
  -H "Authorization: Bearer $YAOKA_API_KEY"

Pour une clé partenaire, conservez ensuite le orgId retourné et envoyez-le dans chaque appel métier. Une clé client classique déduit automatiquement son organisation :

X-Yaoka-Organization-Id: org_...

Conventions

  • JSON UTF-8 pour les requêtes et réponses.
  • Montants et taux de TVA sous forme de chaînes décimales.
  • Idempotency-Key obligatoire sur les créations et actions financières POST documentées.
  • X-Request-Id renvoyé sur chaque réponse pour le diagnostic.
  • Pagination par cursor et nextCursor.
  • Les numéros légaux sont attribués uniquement lors de la finalisation.

Référence machine

  • OpenAPI : GET https://api.yaoka.fr/api/v1/openapi.json
  • État de l’API : GET https://api.yaoka.fr/api/v1/status
  • Documentation lisible par une IA : GET https://api.yaoka.fr/llms.txt
OrganisationsPaiements