Don't worry, carbonAPI
Cette API vous permet de controler et afficher l'impact carbone de vos produits. Créez vos facteurs d'émission, vos produits, et affichez l'estimation de vos produits dynamiquement sur votre site.
Facteurs d'emissions
Sur carbonAPI, les facteurs d'émissions se divisent en deux catégorie : les facteurs d'emissions basiques et les facteurs d'émissions personnalisés. Les premiers sont issus de la base carbone de l'ADEME. Les seconds sont ceux que vous pouvez créer. Attention, pour etre pris en compte, les facteurs d'émission doivent etre créés par des personnes accredités Bilan Carbone par l'Association pour la transition bas Carbone et formés par l'ADEME.
Facteurs d'émissions basiques
Vous pouvez chercher un facteur d'émissions pour l'inclure dans un de vos produits composés. Ces facteurs sont établis par l'ADEME, vous ne pouvez donc pas en créer de nouveaux, les modifier ou les supprimer. Il ne sont que consultables.
Rechercher un facteur d'émission
Vous souhaitez consulter un facteur bien précis, retrouvez-le à partir de son identifiant.
Commande :https://api.carbonad.fr/febfindType envoyé :
data:{
id: string,//necessaire
}
Type reçu :
data:{
nom: string,//necessaire
Localisation?: string,
Sous_localisation?: string,
Incertitude?: number,
Commentaire?: string,
Total: number,//necessaire
Unité: string,//necessaire
CAT1?: string,
CAT2?: string,
CAT3?: string,
CAT4?: string,
CAT5?: string,
} Lister les catégories et les facteurs s'y ratachant
Certainement l'une des fonctions les plus pratiques de carbonAPI. Chaque facteur d'émission est rataché à une catégorie de niveau 1 (Métaux, Agriculture, Carburants fossiles, ... ), et optionnellement à des sous catégories (niveau 2 à 6). La fonction feblist vous retourne les facteurs d'émission correspondants aux catégories demandées. Si plusieurs sous catégories existent, elles vous seront renvoyées. Indiquez alors celle que vous souhaitez explorer pour affiner votre recherche. Si aucune catégorie n'est renseignée, la fonction vous renvoie les catégories de niveau 1.
Commande :https://api.carbonad.fr/feblistType envoyé :
data:{
categorieParent1?: string,
categorieParent2?: string,
categorieParent3?: string,
categorieParent4?: string,
categorieParent5?: string
}
Type reçu :
data:{
Array<{
id: string,//necessaire
Nom?: string,//necessaire
Tags?: string,
Localisation?: string,
Sous_localisation?: string,
Incertitude?: number,
Commentaire?: string,
Total?: number,//necessaire
Unité?: string,//necessaire
CAT1?: string,
CAT2?: string,
CAT3?: string,
CAT4?: string,
CAT5?: string,}>
}
Facteurs d'émissions personnalisés
Créer un facteur d'émission
Créer un nouveau facteur d'émission peut être necessaire lorsqu'aucun facteur d'émission ne correspond à votre produit. De plus cela permet de détailler les émissions selon les différents postes (produit, pack, transport, etc.)
Commande :https://api.carbonad.fr/fecreateType envoyé :
data:{
Nom: string,//necessaire
Localisation?: string,
Sous_localisation?: string,
Incertitude?: number,
Commentaire?: string,
Total: number,//necessaire
Unité: string,//necessaire
CAT1?: string,
CAT2?: string,
CAT3?: string,
CAT4?: string,
CAT5?: string,
}
Type reçu :data:{
id: string
} Modifier un facteur d'émission
Lorsque vous avez créé un facteur d'émission, vous pouvez le modifier. Pour cela, il vous suffira d'envoyer les données et les valeurs que vous souhaitez modifier. Vous pouvez modifier la majorité des valeurs, d'autres sont exclues à la modification comme la date de création ou son identifiant.
https://api.carbonad.fr/femodifieType envoyé :
data:{
id: string,//necessaire
nom_complet?: string,
Tags_français?: string,
Localisation_géographique?: string,
Sous_localisation_géographique_français?: string,
Date_de_création?: string,
Date_de_modification?: string,
Période_de_validité?: string,
Incertitude?: number,
Commentaire_français?: string,
Type_poste?: string,
Nom_poste_français?: string,
Total_poste_non_décomposé?: number,
Unité_français?: string,
CAT1?: string,
CAT2?: string,
CAT3?: string,
CAT4?: string,
CAT5?: string,
}
Type reçu :data:{
} Trouver un facteur d'émission
Retrouvez toutes les caracteristiques de vos facteur d'émission avec cette fonction. En envoyant l'identifiant que vous avez reçu lors de la création, l'API vous renvoie en détail les caractéristiques de votre facteur d'émission personalisé.
https://api.carbonad.fr/fefindType envoyé :
data:{
id: string
}
Type reçu :data:{
Nom: string,//necessaire
Localisation?: string,
Sous_localisation?: string,
Incertitude?: number,
Commentaire?: string,
Total: number,//necessaire
Unité: string,//necessaire
CAT1?: string,
CAT2?: string,
CAT3?: string,
CAT4?: string,
CAT5?: string,
} Supprimer un facteur d'émission
c'est comme créer un facteur d'émission. Sauf que c'est l'inverse. Attention, le facteur d'émission n'est pas supprimé mais deviens inactif. Cela permet aux autres utilisateurs utilisant votre facteur d'émission de continuer à l'utiliser. Il devient introuvable pour la conception de nouveaux objets.
Commande :https://api.carbonad.fr/fedeleteType envoyé :
data:{
id: string
}
Type reçu :data:{
} Rechercher des facteurs d'émissions
Cette fonction permet de renvoyer la liste des facteurs d'émissions correspondant aux mots clés entrés. Simple. Et efficace aussi. Parfait pour trouver le facteur d'émission qui correspond le mieux pour construire votre produit. Les facteurs d'émissions de tous les utilisateurs sont disponibles.
Commande :https://api.carbonad.fr/fesearchType envoyé :
data:{
search:string,//necessaire
}
Type reçu :data:{
Array<
id: string,
Nom?: string,
Tags?: string,
Localisation?: string,
Sous_localisation?: string,
Incertitude?: number,
Commentaire?: string,
Total?: number,
Unité?: string,
CAT1?: string,
CAT2?: string,
CAT3?: string,
CAT4?: string,
CAT5?: string,>
} Les produits
Certes vos produits ont un nom, mais ils ont aussi une empreinte carbone. Celle-ci est composée d'ensembles d'émissions carbones. Chaque émission est composés du poste, de la référence d'un facteur d'émission et du poids correspondant. Le facteur d'émission peut etre choisi parmis les facteurs basiques, personnalisés ou... d'autres objets. La vie est bien faite ! Voyons comment jouer avec :
Créer un produit
Créer un produit est la première étape du reste de sa vie. Ils sont necessaires à l'estimation carbone. La commande renvoi un numéro d'identification : c'est la référence du produit que vous venez de créer. Gardez-le précieusement et enregistrez-le. Il est nécessaire pour toute commande futur concernant ce nouveau produit.
Commande :https://api.carbonad.fr/prodcreateType envoyé :
data:{
nom: string,//necessaire
categorie: string,//necessaire
commentaire: string,
content: Array<Emit>,//necessaire
tags: string,
gps: string //necessaire
}
Type reçu :data:{
id: string
} Modifier un produit
Modifiez le produit pour le faire évoluer.
Commande :https://api.carbonad.fr/prodmodifieType envoyé :
data:{
id: string,//necessaire
owner: string,
nom: string,
categorie: string,
commentaire: string,
content: Array<Emit>,
tags: string,
gps: string,
} Trouver un produit
Pour trouver les détails d'un produit il suffit d'envoyer le numéro d'identification du produit que vous avez créé. CarbonadAPI vous renvoie tous les détails du produit créé précédemment.
Commande :https://api.carbonad.fr/prodfindType envoyé :
data:{
id: string//necessaire
}
Type reçu : data:{
nom: string,//necessaire
categorie: string,
commentaire: string,
content: Array<Emit>,
tags: string,
gps: string//necessaire
} Supprimer un produit
C'est comme créer un produit mais c'est l'inverse.
https://api.carbonad.fr/proddeleteType envoyé :
data:{
id: string//necessaire
}
Type reçu :data:{
} Rechercher un produit
Rechercher un produit permet d'obtenir la liste des produits entrant dans une même catégorie. Pour obtenir cette liste, vous avez juste à envoyer le nom de la catégorie demandé.
prodsearchhttps://api.carbonad.fr/prodsearchType envoyé :
data:{
categorie: string//necessaire
}
Type reçu :data:{
result:Array<{id: string,//necessaire
nom: string,//necessaire
categorie: string,
commentaire: string,
tags: string,
gps: string//necessaire
}>
} Liste des catégories produit disponibles
Pour connaitre la liste des catégories déjà disponibles, tout simplement. La liste renvoyée est celle des catégories où figure au moins un produit.
https://api.carbonad.fr/prodlistcategoriesType envoyé :
data:{
}
Type reçu :data:Array<string>
Estimation carbone
Dès votre premier produit créé vous pouvez vous lancer dans l'estimation. C'est là que carbonAPI prend toute sa saveur.
Estimation
Dans quelques lignes, à peine, vous allez vous régaler. Voilà le coeur de carbonAPI : envoyez lui l'identification d'un produit, la quantité, le lieu de commande (pour les émissions liées au trajet) et recevez l'estimation détaillée. Les informations relatives au poids carbone sont en KgCO2e, conformément à la norme du Bilan Carbone.
https://api.carbonad.fr/estimationType envoyé :
data:{
obj: Array<Emit>,//necessaire
gps: string //necessaire
}
Type reçu :data:{
total: number,//necessaire
note: string,//necessaire
detail:{
extraction: number,
produit: number,
pack: number,
transport: number,
utilisation: number,
fin_de_vie: number
}
} La note est calculée en fonction des autres produits de la même catégorie. La note de A+ présente le produit ayant l'impact estimé le plus bas sur l'ensemble des critères détaillés cumulés. Transport compris. Il est donc normal, selon les coordonnées GPS renseignées à l'envoie, que le note change : car oui, un savon éco-conçu à Chambéry, éco-fabriqué à Grenoble, compostable partout et dont la composition est a faible impact sur les émissions de gaz à effet de serre n'à aucun sens s'il est envoyé dans un hotel à Honolulu...
La répartition entre les différents postes d'émission (produit, pack, transport, utilisation, fin de vie) se fait selon le détails des émissions. Si vous estimez les émissions d'un objet dont les émissions prennent déja en compte le pack, vous n'aurez pas besoin de rajouter ces émissions et elles seront déjà réparties. Vous pouvez cependant rajouter un pack si vous le souhaitez, dans la liste des émissions envoyées. Cela peut etre utile pour différencier un emballage individuel d'un emballage global.
Types
Les données envoyées et reçus correspondent à des formats de donnée précis, ou types. Voici la liste des formats nécessaires qui n'ont pas été détaillés ci dessus:
Type Emit :{poste: Poste,//necessaire
objet: string,//necessaire
quantite: number,//necessaire
gps?: string,//necessaire
}
Type Poste :{
Produit, Packaging, Transport, Utilisation, Fin_de_vie
} Pour renseigner un TypePoste (en créant un nouvel objet, dans la partie content, puis poste, par exemple) il est conseillé d'utiliser le numéro correspondant : pour Produit tapez 1, pour Packaging tapez 2, etc.
Toute l'équipe de carbonad vous remercie et reste à votre disposition pour de plus amples informations. Et ha, oui, une derniere chose : merci. Vous êtes sur la bonne voie, celle de l'économie carbone.