Données référentielles

Fonctionnement

Les données référentielles sont disponibles dans l'API Covage. Elles sont mises à jour régulièrement et permettent de récupérer les informations nécessaires pour interagir avec l'API.

Projets

Les projets sont les projets en cours que vous pouvez avoir avec les équipes commerciales de Covage. Ce endpoint permet de les lister et de récupérer les informations.

GET /api/v1/project

Paramètres

Nom	Type	Description	Obligatoire
code	string	Code du projet	Non
active	boolean	Indique si le projet est actif	Non

Réponse

Nom	Type	Description
code	string	Code du projet
active	boolean	Indique si le projet est actif
start_date	string	Date de début du projet
end_date	string	Date de fin du projet

Le code sera à envoyer lors de la prise de commande

Exemple

  {
      "code": "FLASH",
      "active": true,
      "start_date": "2000-01-01",
      "end_date": "2099-12-31",
      "code_client": "DC999"
  }

Enni

Les enni représentent la liste des portes de collectes que vous possédez. Ce endpoint permet de les lister et d'obtenir plus d'informations les concernant.

GET /api/v1/enni/

Paramètres

Nom	Type	Description	Obligatoire
reference	string	Référence de la porte	Non
name	string	Nom du client	Non
short_name	string	ID du client dans les outils Covage	Non
active	boolean	Indique si la porte de collecte est active	Non
offer	string	type d'offre (BPE/BPEA)	Non
dsp	string	DSP	Non
delivery_mode	string	Mode de livraison	Non

Exemple

GET /api/v1/enni?offer=BPEA&reference=CN001366

Réponse

Nom	Type	Description
Code	string	Code de la porte
Name	string	Nom du client
Short_name	string	ID du client dans les outils Covage
reference	string	Référence de la porte
label	string	Nom de la porte de collecte
offer	string	type d'offre (BPE/BPEA)
dsp	string	DSP
delivery_mode	string	Mode de livraison
active	boolean	Indique si la porte de collecte est active

La référence sera à envoyer lors de la prise de commande

  {
      "code": "720",
      "name": "client",
      "short_name": "DC123",
      "reference": "CN012345",
      "label": "Collecte Nationale Entreprise",
      "offer": "BPEA",
      "dsp": "OXO",
      "delivery_mode": "National",
      "active": true
  }

Affaires

Les affaires sont les affaires en cours que vous pouvez avoir avec les équipes commerciales de Covage. Cet endpoint permet de les lister et de récupérer les informations.

GET /api/v1/business_code

Réponse

Nom	Type	Description
code	string	Code de l'affaire
label	string	Libellé de l'affaire
modification_date	string	Date de modification de l'affaire

Le code sera à envoyer lors de la prise de commande ou lors de récupération de votre catalogue.

Exemple

  {
      "modification_date": "2022-01-14T13:57:04Z",
      "code": "AFAUX01234567890",
      "label": "Affaire [Nom client]-[Enseigne]"
  }

Détail d'un site de facturation

GET /api/v1/billing_site/{site_code}/

Paramètres de la requête

Nom	Type	Description	Obligatoire
site_code	string	code du site	Oui

Réponse

Nom	Type	Description
code	string	Code du site
description	string	Description du site

Exemple

  {
      "code": "AUX00",
      "description": "COVAGE INFRA",
  }

Liste des motifs de demandes de résiliation

GET /api/v1/terminate_reason/

Réponse

Nom	Type	Description
terminate_reasons	liste	Motif de résiliation

Le motif sera à envoyer lors de la demande de résiliation sur la route POST api/v1/order/{order_reference}/terminate/.

Exemple

  {
    "terminate_reasons": [
        "Cessation d'activité",
        "Changement d'Operateur d'Infrastructure",
        "Déménagement sans reprise de lien COVAGE",
        "Déménagement avec reprise de lien COVAGE",
        "Autres motifs, précisez en commentaire"
    ]
  }

Liste des motifs de demandes de modification

GET /api/v1/change_reason/

Réponse

Nom	Type	Description
change_reasons	liste	Motif de modification

Le motif sera à envoyer lors de la demande de modification sur la route POST api/v1/order/{order_reference}/change/.

Exemple

  {
    "change_reasons": [
        "Upgrade (Changement de débit)",
        "Downgrade (Changement de débit)",
        "Modification de Porte de Collecte (principale et/ou sécurisation)",
        "Modification des options du service (ajout, suppression, modification)",
        "Autres demandes de modifications"
    ]
  }