VeganCheck.me API Documentation

Introduction

The VeganCheck.me API is currently in it's early alpha-phase.

The API combines parts of the OpenFoodFacts Database, the OpenBeautyFacts Database, the Brocade.io Database and the Open EAN/GTIN Database. It gives out the following information about a product through the products EAN/UPC/GTIN code:

There is also a VeganCheck.me Ingredients API, documented here.

How to use

JSON End-Point

The APIs base path is https://api.vegancheck.me/v0/product and gives out a JSON response.

You can find the monitoring status page here.

Authenticate

To use the API, you currently have to authenticate using the non-standard HTTP-Header AUTH-KEY.

You can use the key "alpha".

Parameters

The following parameters are available as of now:

parameter usage method
product transmit the barcode of the product GET (as URL-param)
product transmit the barcode of the product POST (as JSON)

Both requests get you the exact same results and you can use the one you like more. At least one of those methods is required, otherwise the API will throw an error.

Responses

We use standardized HTTP status codes as responses. Depending on which language you want to use to implement the API in, you may have to disable error-handling or ignore errors.

Positive response

A successful request will throw a result like this:

Please note:

Error responses

The following error responses can be expected:

Code examples

Python

PHP

Javascript

C#