BonAPI | Alternatives Parameters API Documentation

BONAPI REFERENCE APIs & SUPPORT

Page Overview

Here to help

Information on this page is designed to make it easier for you when first integrating a BonAPI solution.
With the parameter reference API you're able to have an overview of all the possible parameters that can be provided, and we also supply a suggested set of ingredients, along with their profile information so that you can test and integrate the added functionality we offer.
Of course, please do not hesitate to reach out if you have any questions or we can be of any other help.

Testing Ingredients

Below is a set of ingredients with their respective dietary and allergen profiles as well as available composition data types.
The idea is that these will serve to offer as a set of ingredients that can be used to test the various elements of BonAPI's ingredient related solutions as well as react to the different parameter types that can be supplied.
The demo data is offered in multiple languages to suit your requirements, you can choose your own from the drop down.

Available Testing Ingredients

Alternatives Parameters API

The Alternatives Parameters API offers an overview of the different parameters and their respective arguments that can be passed through in BonAPI's solutions. It is only available with a valid BonAPI Token.
All parameter arguments must be provided in their tag form to ensure correct registration.
This API receives no inputs, but can be requested in different languages for your reference.

Optional Parameters

/api/v1/alternatives/parameters//?language=

The default API language can be defined in the BonAPI Account page, meaning all requests with the corresponding token will automatically be analysed in the chosen language.
However, a language parameter can be passed to specify the language of the included inputs of a specific API call. Support for some languages is still in development and experimental, these are marked with*.

    
        
                Arguments
                Type
                Description
                
            

        
                en
                string
                Indicates that the request inputs are in english.
                optional
            

                de
                string
                Indicates that the request inputs are in german.
                optional
            

                nl
                string
                Indicates that the request inputs are in dutch.*
                optional
            

                fr
                string
                Indicates that the request inputs are in french.*
                optional
            

                es
                string
                Indicates that the request inputs are in spanish.*
                optional
            

                it
                string
                Indicates that the request inputs are in italian.*
                optional
            

                lv
                string
                Indicates that the request inputs are in latvian.*
                optional
            

    

Arguments	Type	Description
en	string	Indicates that the request inputs are in english.	optional
de	string	Indicates that the request inputs are in german.	optional
nl	string	Indicates that the request inputs are in dutch.*	optional
fr	string	Indicates that the request inputs are in french.*	optional
es	string	Indicates that the request inputs are in spanish.*	optional
it	string	Indicates that the request inputs are in italian.*	optional
lv	string	Indicates that the request inputs are in latvian.*	optional

Example language parameter:

language=en

Alternatives Parameters API request:

https://www.bon-api.com/api/v1/alternatives/parameters/?language=en

Alternatives Parameters API Response

The above example Alternatives Parameters API request returns the below response.