Comment utiliser l’API Combo ? | Centre d'aide Combo

Prérequis :

Plan requis : People.
Rôle requis : Propriétaire, Administrateur ou rôle RH autorisé. Les directeurs, managers et employés n'ont pas accès à la gestion des tokens.
Ressource technique : L'API n'est pas clé en main. Sa mise en place nécessite un développement de votre côté ou celui d'un partenaire référencé.

Qu'est-ce que l'API Partenaire Combo ?

L'API (Application Programming Interface) Partenaire est une interface qui permet à deux logiciels de communiquer et d'échanger des données de façon automatisée.

Notre API Combo permet de récupérer les données Combo pour les analyser, les retravailler et les connecter à d'autres outils (dashboards, BI, logiciels de paie, caisses, recrutement…).

Comment obtenir un accès API ?

Combo propose deux parcours selon votre situation.

Parcours 1 — Connecter un partenaire référencé

Rendez-vous dans Configuration > Intégration :

Recherchez le partenaire souhaité.
Ouvrez sa fiche pour comprendre les données échangées.
Générez un token associé spécifiquement à ce partenaire. Un token est créé par partenaire et par compte.
Copiez le token et transmettez-le uniquement au partenaire concerné.
Révoquez le token depuis la même fiche si la connexion n'est plus nécessaire.

Parcours 2 — Créer une clé personnalisée

Rendez-vous dans Configuration > Intégration > Accès API :

Cliquez sur Créer une clé.
Nommez la clé pour identifier l'outil ou le projet associé.
Utilisez cette clé pour un développement interne ou un outil non référencé en Marketplace.

💡 Vous n'avez pas encore accès à l'onglet Accès API ou aux différents partenaires dans Intégration ? Cette fonctionnalité est déployée progressivement. En attendant, demandez à parler avec notre équipe support qui générera la clé API à votre place et vous la partagera directement.

Comment sécuriser mes accès API ?

Chaque token donne un accès complet aux données de votre compte. Quelques bonnes pratiques permettent de limiter les risques.

Utilisez un token distinct pour chaque outil ou partenaire connecté.
Ne transmettez jamais le même token à plusieurs partenaires différents.
Ne partagez le token qu'avec le partenaire ou le développeur directement concerné.
Révoquez le token dès qu'un partenaire n'est plus utilisé ou en cas de doute.
Utilisez les identifiants d'établissement (location ID) pour limiter ou filtrer les données lorsque c'est nécessaire.

⚠️ Un token compromis donne accès à l'ensemble des données autorisées de votre compte. En cas de doute, révoquez-le immédiatement depuis la fiche partenaire ou l'onglet Accès API.

Quelles données sont accessibles en lecture (GET) ?

Les données suivantes peuvent être exportées de Combo vers votre outil :

Planning : date du shift, heures planifiées de début/fin, heures réelles de début/fin, temps de pause planifié et réel, note planifiée et réelle, nom et prénom de l'employé, équipe planifiée, étiquette.
Contrats : ID salarié, prénom, nom, numéro de sécurité sociale, dates de début et fin de contrat, temps de travail hebdomadaire, nombre de jours travaillés par semaine, type de contrat, équipe de rattachement, rôle, salaire mensuel brut ou taux horaire brut, e-mail, adresse postale, nationalité, poste de travail, statut forfait jour, motif de fin de contrat.
Historique des contrats : historique complet d'un contrat et de ses avenants.
Contrats terminés : contrats clôturés sur une période donnée.
Chiffre d'affaires : CA prévisionnel et CA réel par établissement pour la semaine en cours.

💡 La masse salariale chargée n'est pas exposée directement via l'API Partenaire Combo. Elle reste calculable à partir des données de salaire brut transmises.

Quelles données sont accessibles en écriture (POST) ?

Les données suivantes peuvent être envoyées vers Combo depuis votre outil :

Chiffre d'affaires : remontée du CA prévisionnel et réel dans le rapport d'analyse Combo — utile si votre logiciel de caisse n'est pas intégré nativement. Le location ID (identifiant de l'établissement) est obligatoire pour chaque envoi.
Matricule employé : mise à jour de l'identifiant employé pour faciliter le matching avec votre logiciel de paie.

💡 L'API Partenaire Combo ne permet pas de créer des shifts, de publier un planning, ni de créer ou modifier des fiches employés.

Pourquoi l'API Combo ne permet-elle pas certaines actions ?

L'API Partenaire Combo est une API principalement en lecture. Elle ne permet pas :

L'import ou la création de plannings depuis un outil externe.
La création ou modification de fiches employés.
La synchronisation bidirectionnelle automatique.
La connexion native à des logiciels de paie — ces connecteurs fonctionnent via des exports dédiés, distincts de l'API Partenaire.

Comment connecter un logiciel de caisse pour remonter le chiffre d'affaire ?

Combo propose des intégrations natives avec les principales caisses du marché, gratuites et réservées aux Admins.

Rendez-vous dans Configuration > Intégration > Caisse :

Cliquez sur la carte de votre logiciel de caisse.
Authentifiez-vous selon le mode propre à chaque caisse (voir ci-dessous).
Associez chaque caisse à l'établissement Combo correspondant.

Caisses disponibles et mode d'authentification :

Zelty — token récupéré depuis l'interface Zelty, à saisir lors de l'activation. Uniquement disponible en France métropolitaine. Une seule clé API Zelty par compte Combo.
Lightspeed K (iKentoo) — connexion avec vos identifiants Lightspeed. La version L de Lightspeed n'est pas prise en charge.
L'Addition — connexion via UID de compte.
Innovorder, Tiller (Sumup), Despi, CarréPOS, Izi Pass — connexion avec identifiants utilisateur.
Menlog — token fourni par Menlog, à saisir lors de l'activation.
PI Electronique — clés (Secret Key, API Key, Code CDPF) à récupérer auprès de votre référent PI Electronique.

Une fois la caisse connectée, le chiffre d'affaire HT remonte automatiquement chaque nuit entre 3h30 et 4h30 (selon le fuseau horaire du compte), à condition que les caisses soient correctement clôturées.

💡

Si votre logiciel de caisse n'est pas dans la liste, utilisez l'API Partenaire (requête POST avec le location ID) pour remonter le chiffre d'affaire manuellement.
L'intégration caisse remonte uniquement le chiffre d'affaire — elle ne transfère aucune autre donnée vers Combo.

FAQ

Ma clé API fonctionne-t-elle pour tous mes établissements ?

Oui, un seul token couvre l'ensemble du compte. Utilisez le location ID pour filtrer les données par établissement.

Puis-je importer des plannings ou créer des employés via l'API ?

Non. L'API Partenaire Combo est principalement en lecture. La création de shifts, la publication de plannings et la création de fiches employés ne sont pas possibles via l'API.

Que se passe-t-il si je révoque un token par erreur ?

L'outil connecté perd immédiatement l'accès aux données Combo. Générez un nouveau token depuis la fiche partenaire ou l'onglet Accès API et transmettez-le à votre partenaire pour rétablir la connexion.

Combien de tokens dois-je demander si je veux connecter deux outils ?

Un token par outil ou partenaire. Ne partagez jamais le même token entre deux partenaires différents — cela rendrait toute révocation sélective impossible.