Skip to content
English
Need to talk?
  • There are no suggestions because the search field is empty.

Glossary  - API use

Here is a quick glossary of most commonly used terms regarding the API use 

  • 201 : HTTP status code 201 (Created) is returned by a server when the POST request succeeds and a new resource has been successfully created.
  • 400 : HTTP status code 400 (Bad Request) is returned by a server when the request sent by the client is incorrect or badly formed. This can happen if the request parameters are missing, if the data sent is invalid, or for other reasons.
  • Sandbox : testing environment, a closed environment where you can send as much data from the 4 different families in order to create studies. It can be cleaned and purged at your request.
  • Production: the real environment where data will be displayed on your Dashboard. It should only be used once tests have been validated by both parties.
  • Bearer Token : a security key, a unique password. One for each environment. To retrieve it, access the platform, go to My Account, then Token API tab or ask your IT referent.
  • Importation Batch : a code added to easily identify a batch of data. It will then be attached to projects to launch the Supplier Data Collection.
  • Project Type : type of contract validated with Fairly Made concerning data submission (STANDARD, AGEC, ect.). Each contract includes four categories, all essential for the analysis: Suppliers / Packaging (optional) / Product / Component.
  • Fairly Made Uniqueness Triplet: The three elements that make the study unique: productRef, productCollectionRef, productColorCode.
  • String : it's a sequence of characters and can contain letters, numbers, symbols and even spaces. Ex. component name
  • Decimal : number. Ex. Packaging: % of recycled material.
  • Boolean : a result that can only have one of two possible values: true or false. Ex. Is the component printed ?