Bienvenue sur le dépôt API Proxy du projet Annuaire des Entreprises.
Ce repository fait partie d'un ensemble de services qui constituent l'Annuaire des Entreprises.
# Installation
npm i
# Lancer le site en dev
npm run dev
# Lancer le site en prod
npm run build && npm run start
L’API est protégée en appel par un header X-API-Key
Une fois doté de ce header vous pouvez appeler les routes suivantes :
// create a PDF download job
https://rncs-proxy.api.gouv.fr/document/justificatif/job/:siren
https://rncs-proxy.api.gouv.fr/document/justificatif/job/status
// download an existing file with the slug given on job creation
https://rncs-proxy.api.gouv.fr/document/downloads/:slug
// status
https://rncs-proxy.api.gouv.fr/status/imr/api
https://rncs-proxy.api.gouv.fr/status/imr/site
- Linter
npm run lint- Tests unitaires
npm run testLe déploiement se fait par Github action
A chaque "merge" sur master :
- Laissez le déploiement se faire automatiquement sur staging via l'action deploy-staging
- Vérifiez vos changements sur staging
- Lancez manuellement le déploiement sur la production : sur deploy-production et cliquez sur "Run workflow" -> "Run workflow"
NB: Si plusieurs déploiements sont déclenchés en même temps, seul le premier va jusqu'au bout. Les autres sont automatiquement interrompus.
Ce projet est sous AGPL 3.0