BIENVENUE
Bienvenue dans la documentation officielle de l’API Nicoka, votre point d’entrée pour intégrer, piloter et interroger les données de votre instance Nicoka via des services web.
Que vous souhaitiez synchroniser des offres d’emploi, gérer les collaborateurs, ou faire dialoguer votre logiciel de paie avec Nicoka, cette API est conçue pour vous offrir une intégration fluide, sécurisée et évolutive.
À propos de Nicoka
Nicoka est un éditeur français de solutions SaaS pour le recrutement (ATS), les ressources humaines (SIRH), le recrutement (ATS), la gestion des clients (CRM) et la gestion d’entreprise (ERP). Parmi ses produits :
- Nicoka SIRH : gestion des collaborateurs, des congés et absences, des notes de frais, des processus RH, des documents légaux, etc.
- Nicoka CABS : solution combinant ATS (recrutement) et CRM pour cabinets et structures de recrutement.
- Nicoka CRM : pour la gestion des prospects, clients, campagnes, etc.
- Nicoka ERP : pour la gestion des projets, tickets et tâches.
Nos solutions sont conçues pour s’intégrer à votre écosystème et vous aider à automatiser et fiabiliser vos processus recrutement / RH.
Objectifs
Cette documentation a pour but de vous guider à travers :
- Les endpoints disponibles (offres d’emploi, candidats, collaborateurs, paie, etc.)
- Les modèles de données (schémas JSON, paramètres)
- Les mécanismes d’authentification (génération de jetons)
- Les exemples d’appels
Premiers pas
Page USAGE
La page USAGE constitue le point de départ essentiel pour comprendre le fonctionnement général de l’API Nicoka.
Vous y découvrirez :
- Les mécanismes d’authentification et la gestion des jetons d’accès ;
- Les paramètres et conventions communes à toutes les requêtes ;
- Les techniques générales applicables à l’ensemble des endpoints, y compris ceux qui ne sont pas explicitement détaillés dans d’autres chapitres (ex. utilisation des branches, filtres dynamiques, gestion des listes, etc.).
Manipulation des objets et sous-objets
La page USAGE vous expliquera également :
- Comment consulter les objets ;
- Comment créer de nouvelles ressources ;
- Comment modifier ou supprimer des données;
- Et comment gérer les sous-objets liés à une ressource principale (ex. candidats, offres, employés, factures, etc.).
Modules
L’API Nicoka est organisée par domaines fonctionnels, les modules, chacun disposant de sa propre documentation détaillée :
| Module | Description | Documentation |
|---|---|---|
| ATS | Gestion des candidats, offres d’emploi, processus de recrutement | → Section ATS |
| CRM | Gestion des prospects, clients, contacts, opportunités et activités | → Section CRM |
| SIRH | Gestion des collaborateurs, absences, notes de frais | → Section SIRH |
| ERP | Gestion projets, facturation et temps | → Section ERP |
| Vente | Gestion des devis, commande, contrats, facuture et paiements | → Section Vente |
| Achat | Gestion des fournisseurs, commande d'achat, factures | → Section Achat |
| Projet | Gestion des projets, activités et temps | → Section Projet |
| Support / Ticket | Gestion des tickets et événements | → Section Support / Ticket |
| Formation | Gestion des collaborateurs, absences, notes de frais, paie | → Section Formation |
🔗 Requêtes inter-modules
Certaines requêtes sont communes à plusieurs modules.
Vous les trouverez dans la Section inter-applications qui regroupe les endpoints transverses permettant notamment les documents, sociétés, agences, etc.
Nous sommes ravis de vous accompagner dans l’intégration de l’API Nicoka !
Si vous avez des questions, des retours ou besoin d’un exemple précis, n’hésitez pas à nous contacter.
Bonne intégration 👋
L’équipe Nicoka