ERP
Généralités
Les entités et endpoints décrits ci-dessous ne sont pas une liste exhaustive. Ils ne représentent que les plus couramment utilisés.
Veuillez vous référer au chapitre USAGE pour en savoir plus.
Remarque
Les paramètres énumérés pour les requêtes "POST" sont uniquement des exemples de paramètres obligatoires. Ils varient selon le sous-domaine utilisé.
L'ensemble des paramètres sont disponibles dans la section "Attributes" de chaque entité
Chemin
Pour accéder à votre API depuis un compte en production vous devez utiliser le chemin suivant :
https://<account_subdomain>.nicoka.com/api/
https://trial.nicoka.com/<account_subdomain>/api/
Note
<account_subdomain> désigne le nom de votre sous-domaine Nicoka
Connexion à l'API
Voir le chapitre Connexion à l'API
Valeurs des listes déroulantes
Dans cette page, vous trouverez les principales entités et endpoints nécesssaires.
La valeur de certains attributs sont disponibles dans Nicoka sous forme de liste. Cette liste est :
- soit disponible depuis le endpoint référencé directement sous l'attribut
- soit reliée à une entité décrite dans cette documentation API
Exemple 1 : Endpoint référencé directement sous l'attribut
source int (Liste déroulante : Provenance)
Provenance de la candidature
Endpoint de récupération des valeurs: /application/entities/462/values/
La liste des valeurs possibles pour source est disponible à cet url:
https://<account_subdomain>.nicoka.com/api/application/entities/462/values/pour un compte en productionhttps://trial.nicoka.com/<account_subdomain>/api/application/entities/462/values/pour compte d'essai
Exemple 2 : Endpoint relié à une entité décrite dans cette documentation
candidateid int (Liste déroulante : Candidat)
Candidat
cliquer sur le lien Liste déroulante : Candidat à côté de l'attribut. Vous serez redirigé vers l'entité correspondante,ici l'entité Candidat.
Vous pourrez alors obtenir la Liste des candidats avec le endpoint correspondant GET /candidates.