• Versions déployées de l’API GesCo Fonds Réparations EEE

  • PreProd = 1.4

  • Prod = 1.3 attention la version 1.4 n’est pas encore déployée en Production

Historique des versions

• version 1.4 prod Apr 2, 2024 / preprod Mar 18, 2024

  • Création d’un dossier Claims (Demande de remboursement) sans création préalable d’un dossier Request (Demande de soutien)
    Pendant encore quelques mois, les anciennes méthodes liées aux Requests (Demande de soutien) sont utilisables pour faciliter la transition

  • calculateecosupport :

    • support de la date de réparation pour valider la période de prise en charge

• version 1.3 Dec 11, 2023

  • Création ou mise à jour de Request sans usage du SMS => mode unique autorisé

• version 1.2 Jul 19, 2023

  • calculateecosupport :

    • support des marques inconnues

    • détection des équipements pris en charge dans le cas d’une marque inconnue par Ecologic ou Eco System

  • CreateSupportRequest

    • support des marques inconnues

  • CreateClaim / UpdateClaim

    • support des marques inconnues

• version 1.1 May 8, 2023

  • printproducttypewithlabellist : ajout d’une méthode permettant d’obtenir les codes symptomes et réparations avec leur intitulé afin de faciliter la présentation dans l’interface utilisateur

  • calculateecosupport : prise en compte du paramètre RepairCode pour définir la prise en charge de la panne si elle est identifiée à cette étape

  • submitclaim : ajout de cette méthode pour déclencher la soumission d’un dossier de remboursement en utilisant uniquement l’ID du dossier. L’usage de UpdateClaim avec le paramètre “submit=true” est toujours possible

  • Code HTTP 206 pour les réponses aux méthodes Create et Update pour les Request (dossier de demande soutien) et Claim (dossier de demande de remboursement)

• version 1.01 Mar 8, 2023

  • getsupportrequestStatus = affichage des erreurs encore présentes (comme pour CreateSupportRequest ou UpdateSupportRequest)

  • getclaimstatus= affichage des erreurs encore présentes dans la demande de remboursement (comme pour CreateClaim ou UpdateClaim)

  • PostMan = mise à jour de la collection

• version 1.0 version initiale Mar 1, 2023

Le diagramme ci-contre, est une proposition de scénario de séquence des appels vers les méthodes de l’API.

La phase initiale consiste à récupérer les informations de référence devant être utilisée par l’application cliente.
Il est recommandé de consolider les référentiels au moins 1 fois par jour.

Une fois les informations sur le produit et l’estimation / devis pour la panne réalisée, la première étape est de s’assurer que la réparation va bien être prise en charge par Ecologic avec “CalculateEcoSupport”.

Si la réponse est positive vous avez le montant du soutien allouable à l’acte de réparation.

La demande de remboursement se crée avec “CreateClaim” et la réponse vous indique s’il vous manque des informations pour pouvoir la soumettre à la vérification (et alors si tout est OK, au paiement).

Généralement, il manque initialement les documents de type, facture, plaque de numéro de série…
Ces documents peuvent être intégrés à la demande de remboursement avec “AttachFile”.
Il est aussi possible de compléter la demande avec “UpdateClaim”.

Si la vérification est OK avec “GetClaimStatus”, vous pouvez faire un “SubmitClaim” en demandant la soumission du dossier.

Le dossier de remboursement passe ensuite dans les étapes de contrôle chez Ecologic.

Vous pouvez aussi générer votre clé de pré-production en vous connectant sur votre compte e-reparateur de Pré-Production (sur https://preprod-ecologic.agoraplus.com/) et dans les informations de celui-ci, utiliser l’entrée “Ma Clé API” dans le menu à droite.

SwaggerUI de l’API de Pre Production = https://preprod-apiecologic.e-reparateur.eco/apidoc/ui/index#/

Requis = disposer de votre clé d’autorisation d’usage de l’API (voir ci-dessu)

Open

une fois votre clé entrée vous pourrez tester les méthodes de l’API

Postman est un outil standard dans le développement et la validation des API Rest.
Nous vous mettons à disposition une collection préparée pour pouvoir tester toutes les méthodes, mais il est recommandé de bien lire les informations fournies pour chacune d’entre elles.

Pour utiliser la collection disponible ci-contre, vous avez juste à réaliser l’importation du fichier json depuis l’interface de Postman.

Ensuite il vous reste à définir votre clé API de Pre Production pour réaliser les appels avec le niveau d’autorisation du site associé.
Pour cela ouvrez l’arborescence de la collection et sélectionnez “Pre Prod” et l’onglet “Authorization” pour y intégrer votre clé API

Pour utiliser une méthode sélectionnez là dans l’arborescence et adaptez les valeurs pour les paramètres et le contenu pour le body selon votre contexte

Collection PostMan à importer

version du Mar 25, 2024

Open

La collection regroupe les méthodes dans des dossiers permettant de plus facilement identifier un ordre type d’usage de celles-ci.
Ce n’est qu’un exemple, il vous est possible d’organiser les appels aux méthodes différemment et de n’utiliser que celles que vous identifiez utiles.

Vous pouvez générer votre clé de production en vous connectant sur votre compte e-reparateur de Production (sur https://www.e-reparateur.eco/) et dans les informations de celui-ci, utiliser l’entrée “Ma Clé API” dans le menu à droite.

Fonctions

Permet de récupérer les ID des sites associés à la clé API utilisée.
Ce sera l’information qu’il faudra ensuite utiliser dans certaines méthodes dans le paramètre “RepairSiteId”

Ex réponse

Réponse avec plusieurs sites

Fonctions

Permet de récupérer la liste des marques supportées par Ecologic.
Appeler cette API vous permettra de disposer d'un code marque unique et de l'associer à votre référentiel.

Usage

entrée = pas de paramètre spécifique

Exemple de réponse

Fonctions

Permet de récupérer la liste des équipements avec

• code unique de l'équipement

• nom de l'équipement

• date d'éligibilité au soutien

• date de fin du soutien

• Tableau des codes pannes

• Tableau des codes symtomes

Exemple usage

entrée = pas de paramètre spécifique

sortie =

ProductId = Identifiant produit

ProductName  =Désignation du type de produit (ex: Four (hors micro-ondes et mini-four))

EligibilityStartDate = Date de début d'éligibilité

EligibilityEndDate = Date de fin d'éligibilité

RepairCodes = Tableau d’une liste des codes pannes IRIS pouvant être utilisés dans la demande de remboursement (Claim) avec leur libellé

IRISSymptoms = Tableau d’une liste des codes symptôme IRIS éligibles pour le type de produits et pour Ecologic à utiliser dans la demande de soutien (Request) avec leur libellé

Exemple de réponse

Fonctions

Permet de récupérer la liste des équipements avec

• code unique de l'équipement

• nom de l'équipement

• date d'éligibilité au soutien

• date de fin du soutien

• Tableau des codes pannes

• Tableau des codes symtomes

.

Exemple usage

entrée = pas de paramètre spécifique

sortie =

ProductId = Identifiant produit

ProductName  =Désignation du type de produit (ex: Four (hors micro-ondes et mini-four))

EligibilityStartDate = Date de début d'éligibilité

EligibilityEndDate = Date de fin d'éligibilité

RepairCodes = Tableau des codes pannes IRIS pouvant être utilisés dans la demande de remboursement (Claim)

IRISSymptoms[] = Liste des codes symptôme IRIS éligibles pour le type de produits et pour Ecologic à utiliser dans la demande de soutien (Request)

Exemple de réponse

Fonctions

Permet de connaître l'éligibilité, l'éco-organisme et le montant du soutien pour un type de produit donné, en fonction du symptôme ou du code section fourni. Cette API n'a pour seul but que de simuler la demande de soutien.

Elle n'effectue aucune demande réelle auprès d'Ecologic.

Données à transmettre

Exemple

Données en entrée

• TotalAmountExclVAT : Montant total HT de la réparation

• TotalAmountExclVAT_Currency : Devise

• BrandId: Code de la marque (retourné préalablement par l'API /PrintBrandList)

• ProductId : Code du type de produit (retourné préalablement par l'API /PrintProductTypeList) 

• au choix

  • IRISSymptom : une des valeurs possibles du code symptome pour le produit issu du référentiel

  • repairCode : une des valeurs possibles du code panne pour le produit issu du référentiel

• optionnel version 1.4

  • repairEndDate : Date de référence de la fin de réparation (ISO8601)

Données en sortie

• EcoOrganizationId: Identifiant e-Reparateur de l'éco-organisme (44=Ecologic, 45=Ecosystem)

• SupportAmount: Montant TTC du soutien

Exemple de paramètre en entrée

Exemple de réponse

Si le produit ou la marque n’est pas connu vous aurez une réponse similaire à

Si le symptôme ne correspond pas au code IRIS du produit l’erreur sera

Si la fiche de compétence (ou fiche métier) associée au produit soumis, issue de la labellisation, n’est pas associée au site faisant la demande un refus sera retourné.

Si la date de réparation repairEndDate ne correspond plus à la panne demandée

Si le produit demandé n’existe pas

Ce qui donne par exemple les paramètres suivants

Si jamais le produit n’est pas pris en charge pour une marque inconnue par Ecologic, la réponse indique une erreur "ResponseMessage": "Invalid organization"

exemple

Fonctions

Permet d'effectuer la demande de remboursement (Claim) en convertissant une demande de soutien (Request)

En retour de cet appel, vous obtiendrez l'ID de votre demande de remboursement (ClaimId), qu'il vous faudra utiliser pour corriger les erreurs de validation, pour ajouter les pièces jointes requises et finalement soumettre votre demande. 

Informations du consommateur obligatoires

Informations du Produit obligatoires

Informations du Produit facultatives

Données en entrée

Dans les paramètres
ex : /createclaim?repairEndDate=2024-03-25T09:00:00Z&repairSiteId=02c867c0-3cef-454d-9a04-3cf8de2dc1c8&consumerInvoiceNumber=FACT_20240325-1&quoteNumber=REF_INT_20240325-1

• RepairEndDate = Date de référence de la fin de réparation (ISO8601)

• RepairSiteId = ID de votre compte e-reparateur.eco

• ConsumerInvoiceNumber = numéro de référence de votre facture cliente

• quoteNumber optionnel = numéro de référence interne chez le réparateur

Dans le body

• IRISSection = il faut intégrer le code panne IRIS parmi ceux associés au produit dans le référentiel

Données en sortie

• IsValid : indique si la création du Claim s’est passée correctement.

• ResponseMessage / ResponseErrorMessage : indique la nature de l’erreur si la création du Claim n’est pas possible

• ResponseData : informations liée au Claim qui vient d'être créé

  • ClaimId : Identifiant du dossier de remboursement

  • IsValid : indique si les données du dossier de remboursement sont complètes et valide (true ou false)

  • ValidationErrors : tableau des erreurs détectées si IsValid = false

version 1.1

Exemple de réponse

exemple pour une prise en charge d’un fer à repasser

Fonctions

Permet d'ajouter un document à une demande de remboursement. 

Un dossier de remboursement peut contenir plusieurs types de fichiers

Les types de fichiers qui peuvent être joints à une demande : 

Données à transmettre

exemple

Données en entrée

Dans les paramètres
ex : /AttachFile?ClaimId=16466&FileName=Facture797&FileExtension=pdf&DocumentType=Invoice

• ClaimId = date de référence du dossier de demande de remboursement, issu de la réponse à CreateClaim

• FileName = nom du fichier transmis (sans l’extension)

• FileExtension = extension du fichier (voir ci contre)

  • permet de définir le type

  • extension sans le point “.”

• DocumentType = type de document transmis à intégrer dans la demande (voir les codes identifiants ci contre)

Dans le body

• FileContent = contenu du fichier en Base64

Données en sortie

• "Code 200 -> OK"

Le statut de sortie est géré par le statut de la réponse HTTP

• Code 200 -> OK

• Code 400 -> Bad request

• Code 500 -> Internal Error

Fonctions

Permet de mettre à jour, de corriger et de soumettre la demande de remboursement. La mise à jour n'est plus possible après la soumission de la demande.

Données à transmettre

Exemple (les données ci-dessous de l’exemple sont à mettre à jour; en effet des champs sont obsolètes)

Données en entrée

Dans les paramètres
ex : /UpdateClaim?ClaimId=5310865&repairEndDate=2023-02-24T11:00:00Z&RepairSiteId=02c867c0-3cef-454d-9a04-3cf8de2dc1c8&consumerInvoiceNumber=FACT_20230301-1&quoteNumber=REF_INT_20230301-1&Submit=false

• ClaimId = date de référence du dossier de demande de soutien, issu de la réponse à CreateSupportRequest

• RepairEndDate = Date de référence de la fin de réparation (ISO8601)

• RepairSiteId = ID de votre compte e-reparateur.eco

• ConsumerInvoiceNumber = numéro de référence de votre facture cliente

• quoteNumber optionnel = numéro de référence interne chez le réparateur

Dans le body

Données en sortie

• ClaimId : Identifiant du dossier de remboursement en cours

• IsValid : indique si le dossier de remboursement est valide (true ou false)

• ValidationErrors : tableau des erreurs détectées si IsValid = false

version 1.1

Exemple de réponse

Si la soumission est OK

Facture non conforme à la soumission

Exemple de facture non liée à l’utilisateur

Fonctions

Permet de connaitre le statut d'une demande de remboursement qui a été soumise.

Données à transmettre

Exemple

/GetClaimStatus?ClaimId=5312276

Données en entrée

Dans les paramètres
ex : /GetClaimStatus?ClaimId=5312276

• ClaimId = date de référence du dossier de demande de soutien, issu de la réponse à CreateSupportRequest

Données en sortie

• ValidationErrors : liste des erreurs encore présentes dans le dossier empêchant sa soumission

• LastStatus : Dernier statut de la demande de soutien

  • “Dossier incomplet” : des pièces ou des informations doivent être ajoutées au dossier de demande de remboursement (Claim) avant de tenter de le soumettre

Exemple de réponse

Fonctions

Permet de soumettre simplement un dossier

Données à transmettre

Exemple

/submitclaim?claimId=5275562

Données en entrée

Dans les paramètres
ex : /submitclaim?claimId=5275562

• claimId = date de référence du dossier de demande de soutien, issu de la réponse à CreateSupportRequest

Données en sortie

• ResponseData : détails sur le traitement

  • IsValid : indique si la soumission a été validée

  • ValidationErrors : liste des erreurs encore présentes dans le dossier empêchant sa soumission

Exemple de réponse

si la soumission contient des erreurs :

Si la soumission est OK