PEFTrust Public API
v5.13.2
The PEFTrust Public API allows certain operations such as creating an evaluation without any user interface.
This API is directly linked to your organization, therefore a specific user must be created from the application interface with the associated role or the support will provide it to you. Note that each operations that you execute will be applied in the application user interface too.
Documentation
This document explains everything you should know before performing any type of operations with the API.
Markdown format PDF format
Postman collection
This document contains a complete requests sequence with examples.
Download
Changelog
v5.13.2
  • This release provide the ability to specify a database for materials when using the API
  • Changed PUT /evaluations/:id (add database to composition.parts.materials)
  • Changed PATCH /evaluations/:id (add database to composition.parts.materials)
  • Changed POST /evaluations (add database to composition.parts.materials)
    • This release provides a new endpoint to retrieve the changelog in a rss feed format.
v5.13.1
  • Added GET /rss/feed endpoint
v5.12.3
  • This release provides a way to evaluate your evaluations in asynchronous system using webhooks.
  • Added GET /evaluations/evaluate/:id/full endpoint
  • Changed GET /evaluations/evaluate/:id/ecobalyse (add webhook, webhook_token and async parameters)
  • Changed GET /evaluations/evaluate/:id (add webhook, webhook_token and async parameters)
v5.11.9
  • This minor release includes functional units and precalculated score in the results full, so you don't have to do it by your own anymore.
  • Added GET /tags example
  • Changed GET /results/evaluation/:id/full include precalculated scores (calculatedScores property)
  • Changed GET /results/product/:id/full include precalculated scores (calculatedScores property)
v5.8.0
  • This release add compatibility with Ecobalyse form some products and evaluations. It also changes every departments related endpoints to teams. Ids and reference are preserved.
  • Added GET /evaluations/evaluate/:id/ecobalyse to evaluate an evaluation with through Ecobalyse API
  • Added GET /evaluations/check/:id/ecobalyse to check if an evaluation is able to be evaluated with Ecobalyse
  • Added GET /results/evaluation/:id/ecobalyse to get the evaluation results from Ecobalyse (need to have been evaluated)
  • Added GET /results/product/:id/ecobalyse to get the product results from evaluation Ecobalyse results
  • Changed GET /departments /teams
  • Changed GET /departments/:id /teams/:id
  • Changed POST /departments /teams
  • Changed PUT /departments /teams/:id
  • Changed DELETE /departments /teams/:id
  • Changed ALL ENDPOINTS including department or departments information in their data for team or teams
v5.7.9
  • Ability to use any of the allowed values property as value using useProperty in parameter object, see documentation example.
  • Changed GET /evaluations/categories/schema/:id (add slug in allowed values for select type fields)
  • Changed GET /materials/schema/:id (add slug in allowed values for select type fields)
  • Changed POST /evaluations (add useProperty handling)
  • Changed PUT /evaluations/:id (add useProperty handling)
v5.6.0
  • Change the way we handle update on entities. Now, you can send only the fields you want to update, with atomic operation and search queries for evaluations. Other entities work the same way as before but their update endpoint has been changed from PATCH to PUT to respect RESTful API conventions as long as these endpoints are not atomic and require a full update.
  • Added GET /evaluations/schema/:id (Get the current schema to send for PUT or PATCH for a given evaluation)
  • Added PUT /masks/:id
  • Removed PATCH /masks/:id (switched to PUT)
  • Added PUT /products/packagings/:id
  • Removed PATCH /products/packagings/:id (switched to PUT)
  • Added PUT /products/:id
  • Removed PATCH /products/:id (switched to PUT)
  • Added PUT /evaluations/:id
  • Changed PATCH /evaluations/:id (switched to PUT, PATCH now handle atomic changes)
v5.0.0
  • Product endpoints are finally separated from evaluations. They provide a way to join multiple evaluation to a final product. You can now create a product composed of multiple evaluations and get the final results for multi-items, lot, multi-sourcing. The previous existing evaluation have been all copied as a standard product which is a product related to one and only one evaluation. For the next evaluations, you will have to create a product and then add evaluations to it manually if you do so through the API.
  • Added GET /products
  • Added GET /products/:id
  • Added POST /products
  • Added PATCH /products
  • Added DELETE /products
  • Added GET /products/packagings
  • Added GET /products/packagings/:id
  • Added GET /products/packagings/schema
  • Added POST /products/packagings
  • Added PATCH /products/packagings
  • Added DELETE /products/packagings
  • Added GET /results/product/:id/ipc
  • Added GET /results/product/:id/full
  • Changed POST /evaluations
  • Changed PATCH /evaluations/:id
v5.0.0-beta
  • Most of the changes are related to the wording change of product for evaluation. Indeed, this is a requirement for the next improvements such as multiple evaluations composed products etc.
  • Changed GET /products for /evaluations
  • Changed POST /products for /evaluations
  • Changed GET /products/:id for /evaluations/:id
  • Changed GET /products/evaluate/:id for /evaluations/evaluate/:id
  • Changed PATCH /products/:id for /evaluations/:id
  • Changed DELETE /products/:id for /evaluations/:id
  • Changed PATCH /products/publish/:id for /evaluations/publish/:id
  • Changed GET /products/categories for /evaluations/categories
  • Changed GET /results/product/:id for /results/evaluation/:id
  • Changed GET /results/product/:id/full for /results/evaluation/:id/full
  • Changed GET /results/product/:id/ipc for /results/evaluation/:id/ipc (The response does not contain "product" property anymore, it has been replaced with "evaluation")
  • Changed GET /accessories the product_category_id parameter has changed for evaluation_category_id
v2.2.0
  • Added /masks(/:id) endpoints, to create and perform any CRUD operations on masks
  • Changed /products improvements in validation
v1.32.2
  • Added /results/product/:id/ipc endpoint, to retrieve IPC results for a given product
  • Added /product/latest-versions endpoint, to see latest published versions of your reference products
  • Added /product/publish/:id endpoint, to publish a reference product and get a versionned product with all results included
  • Added /product/duplicate/:id endpoint, to deplicate a reference product
  • Fixed fixes /product/evaluate/:id endpoint
v1.25.2
  • Added departments endpoints
  • Changed departments is now required in products create and update
v1.9.2 (breaking changes)
  • Added composition.baseUnit field with percentage or weight depending on which unit you want to use (required)
  • Added composition.totalWeight to specify product total weight (required)
  • Changed Composition part and material object must have a weight or percentage field depending on the baseUnit
  • Changed Accessories array become an object with items (previously the accessory array) and percentage or weight depending on the baseUnit;