optnc/ridet-nc-api

By optnc

Updated 4 months ago

Provides enriched data about companies and their establishments in New Caledonia using RID / RIDET

Image
0

203

Docker PullsDocker StarsDocker Image Version (latest by date)Docker Image Size (latest by date)Api description

API REST

❔ Goal

API sending open data concerning companies in New Caledonia and their establishments.

🚀 Usage

docker run --rm -d -p 8080:8080 docker.io/optnc/ridet-nc-api:latest

📍 Endpoints

GET /companies/{rid}
GET /companies/{rid}/establishments
GET /establishments/{ridet}
GET /communes/{codeGeo}

🎭 Request examples

Simple http request using httpie tool.

http :8080/companies/0132720
http :8080/companies/0132720/establishments
http :8080/establishments/0132720001
http :8080/communes/98818

💗 Health

❤️‍🩹 Status endpoint : http://localhost:8080/q/health

http :8080/q/health

📗 Documentation

📝 OpenApi : http://localhost:8080/q/openapi

http :8080/q/openapi

📖 Swagger : http://localhost:8080/q/swagger-ui/

Docker Pull Command

docker pull optnc/ridet-nc-api