Documentation
Cette documentation présente le fonctionnement des API mises à disposition par Cap emploi. Elle s'adresse aux personnes familiarisées avec le développement d'applications et doit leur permettre d'utiliser rapidement ces API.
Pré-requis
Pour utiliser une API, vous devez au préalable avoir :
Identifiants
Une clé publique (identifiant) et une clé secrète vous sont délivrées par application lorsque votre accès a été validé.
Conservez précieusement ces informations nécessaires pour requêter les API. Vous les retrouverez à tout moment sur la page de configuration de votre application accessible depuis votre espace.
Veillez à protéger votre identifiant client et clé secrète en suivant ces bonnes pratiques :
- Ne faites pas figurer vos identifiants en clair dans le code source de votre application mais enregistrez-les dans des variables d'environnement ou dans des fichiers dédiés protégés
- Retirez ceux devenus inutiles et informez le support qui les supprimera
- Lorsque vous publiez du code sur une plateforme de gestion de versions, assurez-vous que vos identifiants n'apparaissent pas
- La clé secrète doit être uniquement présente sur la partie serveur de votre application
Protocoles et standards
- Les API exposées respectent les contraintes de l'architecture REST
- Les ressources sont distribuées au format JSON