Rechercher un contrat

GET/search_contract interroge en un seul appel tous les gestionnaires de réseau que nous intégrons. Envoyez un identifiant de point de livraison, une adresse, ou les deux ; chaque opérateur concerné répond pour lui-même.

Il remplace POST/integration/enedis/search_contract, qui n'interrogeait qu'Enedis.

Paramètres

deliveryPointId ou address est requis.

Réponse

{
  "results": [
    {
      "deliveryPointId": "00059461297239",
      "provider": {
        "oreCode": "ENED",
        "name": "Enedis",
        "energyType": "electricity"
      },
      "address": ["1 RUE DE LA PAIX", "75001 PARIS"],
      "resOrPro": "RES",
      "name": "JEAN DUPONT",
      "confidence": 90,
      "contractId": "606b5149-1ef0-414a-8019-a050f64cc0ac"
    }
  ],
  "unresolved": [
    {
      "provider": { "oreCode": "GRDF", "name": "GRDF", "energyType": "gas" },
      "messages": [
        {
          "code": "ADDRESS_SEARCH_NOT_SUPPORTED",
          "fr": "La recherche par adresse pour le gaz n'est pas disponible. Veuillez fournir un numéro de PCE.",
          "en": "Address-based search for gas is not available. Please provide a PCE number."
        }
      ]
    }
  ]
}

results — les points de livraison. Chaque entrée porte un deliveryPointId et un provider.

unresolved — les opérateurs qui n'ont renvoyé aucun point, avec la raison. Une entrée n'a pas d'identifiant : elle décrit un opérateur, pas un point.

messages à la racine porte sur toute la réponse, pas sur un opérateur. Parfois, on veut indiquer pourquoi un opérateur donné ne renvoie aucun résultat, par exemple.

confidence et messages

confidence indique à quel point une ligne répond à votre recherche, de 0 à 100. 100 est le meilleur cas : l'identifiant envoyé est confirmé et tout le reste concorde. Moins un élément envoyé concorde, et moins le point est localisé avec certitude, plus elle baisse.

messages indique d'éventuelles raisons pour lesquelles certaines informations ne sont pas disponibles. Chaque message porte un code sur lequel brancher et un texte fr / en affichable tel quel.

Créer un Ask à partir d'un résultat : contractId

Quand nous détenons le contrat d'un point, le résultat porte un contractId : passez-le tel quel comme élément de contracts dans POST/ask, comme l'id de la recherche Enedis existante.

Aujourd'hui ce mécanisme n'est disponible qu'avec Enedis, et uniquement lorsque le titulaire a été confirmé : contractId n'est présent que si la recherche comportait un name qu'Enedis a validé. Sans contractId — GRDF, ESR, ou une recherche sans name — vous devrez fournir nom, adresse et point de livraison vous-même dans contracts. Voir Créer un Ask.

Version limitée

Les Workspaces qui ont opté pour le plan gratuit disposent de la version limitée de GET/search_contract, tant qu'ils n'ont pas souscrit à un plan payant. Les restrictions sont les suivantes :

• chaque recherche doit porter un deliveryPointId (le PRM pour Enedis). Sans lui, la réponse est une erreur 403 ;
• la réponse ne contient aucun titulaire (name), et chaque address est réduite au code postal : ["67110"].

Le reste de la réponse est inchangé : confidence, messages, et le contractId d'un titulaire vérifié, avec lequel créer un Ask. Le name que vous envoyez sert toujours à vérifier le titulaire.

Pour lever cette limitation, souscrivez à un plan payant en nous contactant à contact@switchgrid.tech.

Champs absents

Les champs que nous ne pouvons pas remplir sont omis. address, name, resOrPro, messages et contractId sont optionnels sur un résultat.

Par exemple, un name peut être absent si :

• HOLDER_NOT_VERIFIED — le titulaire n'a pas été vérifié. Fournissez un name.
• NAME_MISMATCH — le nom fourni n'est pas celui du titulaire.
• votre espace a la version limitée de la recherche.

Codes

Codes d'absence

Codes transitoires

Codes liés aux capacités des API partenaires

Codes décrivant des réserves sur les résultats retournés

Capacités par opérateur

Un nom envoyé à un opérateur qui ne peut pas le vérifier renvoie NAME_CHECK_NOT_SUPPORTED, pour qu'un nom non vérifié ne soit pas pris pour un nom confirmé.

Enedis ne communique le nom du titulaire que si vous en fournissez au moins 3 lettres qui correspondent à ce qu'ils ont en base de données.