IQNeoXen / VeganCheck.me-API

Official VeganCheck.me API written in Node.js

VeganCheck.me API (v0.2.0)

The official API powering VeganCheck.me.

Documentation

Please refer to VeganCheck.me API Documentation for a full documentation.

To learn more about this repo, head to: https://frontendnetwork.github.io/VeganCheck.me-API/.

There is an official Wrapper for React available on npm.

Swagger

The OpenAPI.yml can be imported into Swagger and is available here: Swagger Editor

Postman

Postman Collection is available for download here: VeganCheck API.postman_collection.json.zip

API Endpoints

Warning
All endpoints are only accessible via HTTPS. All HTTP requests will be rerouted to HTTPS.
Making a request over HTTP may cause data to be transmitted unencrypted for a short time and the server to send a 301 code.

Available endpoints

The following endpoints are available within the VeganCheck.me API:

• POST: https://api.vegancheck.me/v0/product/{barcode}
• GET: https://api.vegancheck.me/v0/ingredients/{ingredientslist}
• GET: https://api.vegancheck.me/v0/peta/crueltyfree

Unavailable endpoints

The following endpoints are currently unavailable within the public VeganCheck.me API. They're not on the roadmap and will not be published:

• GET: https://api.vegancheck.me/v0/peta/veganapproved
• POST: https://api.vegancheck.me/v0/grades/backend