GUIDE D'UTILISATION API CERTIFIED CAPACITIES REGISTRY - API Data RTE
←
→
Transcription du contenu de la page
Si votre navigateur ne rend pas la page correctement, lisez s'il vous plaît le contenu de la page ci-dessous
Guide d’Utilisation API Certified Capacities Registry Version 1.1
GUIDE D’UTILISATION
API CERTIFIED CAPACITIES REGISTRY
Version 1.1
Date d’entrée en vigueur : 22 Février 2018
1Guide d’Utilisation API Certified Capacities Registry Version 1.1
SOMMAIRE
1 INTRODUCTION ________________________________________ 3
1.1 Définitions ........................................................................................... 3
1.2 Assistance technique ............................................................................ 4
2 DESCRIPTION FONCTIONNELLE DE L’API CERTIFIED CAPACITIES REGISTRY _ 5
2.1 Description générale ............................................................................. 5
2.2 Pré-requis à l’utilisation des API ............................................................. 5
2.2.1 Confidentialité des données ...................................................................... 5
2.2.2 Résiliation ................................................................................................ 5
2.3 Ressource « ncc_greater_equal_100_mw » ............................................ 5
2.4 Ressource « ncc_less_100_mw » ........................................................... 5
3 ACCES A L’API ________________________________________ 6
4 RESSOURCES EXPOSEES PAR L’API « CERTIFIED CAPACITIES REGISTRY » __ 7
4.1 Ressource /ncc_greater_equal_100_mw ................................................. 7
4.1.1 GET /ncc_greater_equal_100_mw ............................................................. 7
4.1.1.1 Modalités d’appel ............................................................................ 7
4.1.1.2 Entrées .......................................................................................... 8
4.1.1.3 Sorties ........................................................................................... 9
4.1.1.4 Règles de gestion ......................................................................... 12
4.1.1.5 Codes erreurs ............................................................................... 13
4.2 Ressource /ncc_less_100_mw ..............................................................14
4.2.1 GET /ncc_less_100_mw .......................................................................... 14
4.2.1.1 Modalités d’appel .......................................................................... 14
4.2.1.2 Entrées ........................................................................................ 15
4.2.1.3 Sorties ......................................................................................... 16
4.2.1.4 Règles de gestion ......................................................................... 18
4.2.1.5 Codes erreurs ............................................................................... 19
5 DETAILS DES ERREURS __________________________________ 20
5.1 Erreurs fonctionnelles ..........................................................................22
5.1.1 ncc_greater_equal_100_mw ................................................................... 22
5.1.2 ncc_less_100_mw .................................................................................. 23
5.2 Erreurs techniques...............................................................................24
6 ANNEXES ___________________________________________ 26
6.1 Fichiers Exemples ................................................................................26
FIN DU DOCUMENT _____________________________________ 26
2Guide d’Utilisation API Certified Capacities Registry Version 1.1
1 Introduction
Ce document décrit l’API Certified Capacities Registry en version 1 mise à disposition par RTE à ses
Clients dans le but d’exposer les données des capacités certifiées des Entités de Certification (EDC).
Documents de référence
Référence Titre du document Référence complète
courte
[R1] CGU des API RTE Lien accès
1.1 Définitions
Les termes utilisés dans le Guide d’Utilisation et dont la première lettre est une majuscule sont définis
ci-dessous ou, à défaut, dans les Conditions Générales d’Utilisation [R1] :
API Application Programming Interface (Interface de programmation
applicative)
Authentification Mode de Protection permettant de s’assurer que l’identité de l’Émetteur ou
du Récepteur a été vérifiée par RTE et qu’il est donc autorisé à accéder au
SI et à utiliser les Applications.
EDC Entité De Certification
Émetteur Partie qui émet un Message.
Message Ensemble de données informatiques destiné à véhiculer des informations et
structuré selon un ordre spécifié dans le Guide d’Utilisation. Un Message
peut être émis par l’Utilisateur ou RTE.
NCC Niveau de Capacité Certifié
Opération Une opération est la manière dont le client interagit avec la ressource de
l’API. Il s’agit d’un verbe http (par exemple : GET pour lecture)
Partie ou Parties Dans le cadre du Guide d’Utilisation, il s’agit, individuellement, soit de RTE
soit de l’Utilisateur et, conjointement, de RTE et de l’Utilisateur.
Récepteur Partie qui reçoit le Message de l’Émetteur.
Ressource Une ressource représente la donnée sur laquelle l’application cliente
interagit.
URL Uniform Resource Locator : chaîne de caractères suivant un format
spécifique permettant de localiser une ressource sur un réseau et d’identifier
un moyen d’agir (protocole) sur cette ressource.
Utilisateur(s) Personne morale ayant validé les Conditions Générales d’Utilisation des API
de RTE et accédant au SI de RTE afin d’utiliser les API mises à dispositions
par RTE.
Traduction des valeurs anglaises retournées par l’API :
Valeur en Anglais en sortie de l’API Traduction en Français
OTHER Autre
OTHER_RENEWABLE Autre renouvelable
BIOMASS Biomasse
3Guide d’Utilisation API Certified Capacities Registry Version 1.1
WASTES Déchets industriels
DEMAND_RESPONSE Effacement
WIND_OFFSHORE Eolien offshore
WIND_ONSHORE Eolien onshore
HYDRO_RUN_OF_RIVER_AND_POUNDAGE Fil de l’eau et écluse
GAS_ORIGINALY_FROM_COALl Gaz issu du charbon
GAS_COAL_HARD_COAL Gaz, houille/ charbon
GEOTHERMAL Géothermique
HYDRO_RESERVOIR Lac
COAL_LIGNITE Lignite
MARINE Marine
VARIOUS Multi-filière
NUCLEAR Nucléaire
FOSSIL_OIL Pétrole / fioul
SHALE_OIL Pétrole de schiste
HYDRO_PUMPED_STORAGE Pompage hydraulique
SOLAR Solaire
PEAT Tourbe
TSO RPT
DSO RPD
VARIOUS_SYSTEM_OPERATORS Multi GR
PRODUCTION Production
CPC OA (Obligation d’achat)
PLANNED En projet
OPERATING En service
1.2 Assistance technique
En cas de difficulté pour l’accès ou l’utilisation d’une API, l’Utilisateur peut faire appel aux services
d’assistance téléphonique mis en place par RTE dans les conditions techniques prévues dans les
Conditions Générales d’Utilisation.
4Guide d’Utilisation API Certified Capacities Registry Version 1.1
2 Description fonctionnelle de l’API Certified Capacities
Registry
2.1 Description générale
L’API permet d’accéder à deux ressources permettant d’obtenir les données de capacité certifiée. Ces
deux ressources sont uniquement accessibles en lecture, via une opération de type GET.
2.2 Pré-requis à l’utilisation des API
L’API Certified Capacities Registry est destinée aux acteurs du marché de l’électricité et au grand
public. Néanmoins les utilisateurs de l’API doivent créer un compte sur le portail digital de Rte. La
création de ce compte permet d’obtenir des identifiants Oauth 2.0. Ces identifiants sont ensuite requis
lors des appels aux API.
2.2.1 Confidentialité des données
Les informations contenues dans les Messages ne pourront être utilisées à d’autres fins que celles
prévues dans les Conditions Générales d’Utilisation [R1].
2.2.2 Résiliation
L’abonnement à une API est automatiquement résilié lorsque l’utilisateur supprime son compte sur le
portail Digital RTE.
Si l’Utilisateur souhaite ne plus utiliser une API sans résilier l’abonnement, il suffit de cesser l’émission
des appels à l’API.
2.3 Ressource « ncc1_greater_equal_100_mw »
Cette ressource permet d’obtenir les données des EDC dont le niveau de capacité certifiée est supérieur
ou égal à 100 Mw.
2.4 Ressource « ncc_less_100_mw »
Cette ressource permet d’obtenir un agrégat des données d’EDC par filière dont le niveau de capacité
certifiée est inférieur à 100 Mw.
1
Niveau de Capacité Certifié
5Guide d’Utilisation API Certified Capacities Registry Version 1.1
3 Accès à l’API
L’accès à l’API décrite dans ce document se fait via le protocole REST.
Comme pour toutes les API mises à disposition par RTE, l’accès et l’utilisation de ces API sont soumis
aux termes des Conditions Générales d’Utilisation [R1].
La méthode d’autorisation d’accès aux API est OAuth, dont les usages sont décrits dans la FAQ.
6Guide d’Utilisation API Certified Capacities Registry Version 1.1
4 Ressources exposées par l’API « Certified Capacities Registry
»
4.1 Ressource /ncc_greater_equal_100_mw
4.1.1 GET /ncc_greater_equal_100_mw
4.1.1.1 Modalités d’appel
La ressource est exposée de la manière suivante :
Exposition REST / JSON
Méthode GET
https://digital.iservices.rte-
URL ressource france.com/open_api/certified_capacities_registry/v1/ncc_greater_equal_100_mw
?start_date=&end_date=
https://digital.iservices.rte-
URL sandbox (1)
france.com/open_api/certified_capacities_registry/v1/sandbox/ncc_greater_equal_
100_mw
(1)
La sandbox ne prend pas en compte les paramètres d’entrées
Préconisations d’appels
Cette ressource a pour objectif de permettre de récupérer les EDC dont le niveau des capacités certifiées
est supérieur ou égal à 100 MW. Dans le cas d’utilisation nominal il n’est pas nécessaire de renseigner
les champs de la période. La ressource retourne automatiquement les données A+4 (année en cours +
4 ans).
Ce Service met à disposition des données à partir du 01/01/2017. Les données antérieures à cette
date ne sont pas disponibles.
Il est conseillé de faire un appel par jour à ce service de début Janvier au 1er Novembre puis un appel
par semaine jusqu’à fin décembre.
Pour continuer à récupérer les informations de certification de cette même période sur les 3 années
suivantes nous vous conseillons d’utiliser le mode historique en faisant 1 appel par mois.
Il est conseillé de ne pas dépasser une période de 6 années par appel.
7Guide d’Utilisation API Certified Capacities Registry Version 1.1
4.1.1.2 Entrées
NOM CARD. DESCRIPTION TYPE VALEURS / FORMAT REGLES
Date de début des données YYYY-MM- NGE100MW-RG01
start_date 0..1 date
demandées DDThh:mm:sszzzzzz1 NGE100MW-RG02
Date de fin des données YYYY-MM- NGE100MW-RG01
end_date 0..1 date
demandées DDThh:mm:sszzzzzz1 NGE100MW-RG02
1
Les dates en paramètre peuvent être exprimées sur n’importe quel fuseau horaire
Exemples d’appel :
Sans paramètre
URL:
GET /open_api/certified_capacities_registry/v1/ncc_greater_equal_100_mw
HTTP/1.1
Headers:
Host: digital.iservices.rte-france.com
Authorization: Bearer CNAPbfmg7GjvtqTTlKqPm8ykP6R8YJFfJPnyjqW8p1v2PW2UX6bF8z
Body:
Avec tous les paramètres
URL:
GET /open_api/certified_capacities_registry/v1/ncc_greater_equal_100_mw?start_date=2015-06-
08T00:00:00%2B02:00&end_date=2015-06-11T00:00:00%2B02:00
HTTP/1.1
Headers:
Host: digital.iservices.rte-france.com
Authorization: Bearer CNAPbfmg7GjvtqTTlKqPm8ykP6R8YJFfJPnyjqW8p1v2PW2UX6bF8z
Body:
8Guide d’Utilisation API Certified Capacities Registry Version 1.1
4.1.1.3 Sorties
NOM CARD. DESCRIPTION
ncc_greater_equal_
1..1 Tableau de valeurs {JSON} structuré comme suit :
100_mw
NOM CARD. DESCRIPTION TYPE VALEURS / FORMAT REGLES
NGE100MW-RG03
YYYY-MM-
start_date 1..1 Date de début des données demandées date
DDThh:mm:sszzzzzz1 NGE100MW-RG04
YYYY-MM- NGE100MW-RG04
end_date 1..1 Date de fin des données demandées date
DDThh:mm:sszzzzzz1
YYYY-MM-
updated_date 1..1 Date de mise à jour de la donnée date
DDThh:mm:sszzzzzz1
edc Objet {JSON} structuré comme suit :
NOM CARD. DESCRIPTION TYPE VALEURS / FORMAT REGLES
Une des valeurs suivantes :
OTHER
OTHER_RENEWABLE
BIOMASS
WASTES
DEMAND_RESPONSE
WIND_OFFSHORE
WINF_ONSHORE
HYDRO_RUN_OF_RIVER_A
ND_POUNDAGE
GAS_ORIGINALY_FROM_C
production_ Filière de l’Entité De OALl
1..1 enum
type Certification GAS_COAL_HARD_COAL
GEOTHERMAL
0..n
HYDRO_RESERVOIR
COAL_LIGNITE
MARINE
VARIOUS
NUCLEAR
FOSSIL_OIL
1..1
SHALE_OIL
HYDRO_PUMPED_STORAGE
SOLAR
PEAT
Code de l’Entité De string
code 1..1 Texte
Certification
Libellé de l’Entité De string NGE100MW-RG03
name 1..1 Texte
Certification
Une des valeurs suivantes :
enum
TSO
network_co Réseau de l’Entité DSO
1..1
nnection De Certification VARIOUS_SYSTEM_OPERAT
ORS
1..1 enum Une des valeurs suivantes :
Type de l’Entité De PRODUCTION
type
Certification DEMAND_RESPONSE
CPC
1..1 enum Une des valeurs suivantes :
Statut de l’Entité De
status PLANNED
Certification
OPERATING
9Guide d’Utilisation API Certified Capacities Registry Version 1.1
Date de certification date
certification YYYY-MM-
1..1 de l’Entité De
_date DDThh:mm:sszzzzzz1
Certification
nnc Objet {JSON} structuré comme suit :
NOM CARD. DESCRIPTION TYPE VALEURS / FORMAT
Niveau de Capacité Certifiée évolué
suite aux éventuelles demandes
updated_ncc 1..1 int Entier numérique
d’évolution de paramètre accordées
(en Mw)
1..1
Niveau de Capacité Certifiée initial
intial_ncc 1..1 suite à la demande de certification int Entier numérique
(en Mw)
Niveau de Capacité Certifiée
Previsionnel suite aux éventuelles
forecast_ncc 1..1 int Entier numérique
demandes de réequilibrage
accordées (en Mw)
rpc Objet {JSON} structuré comme suit :
NOM CARD. DESCRIPTION TYPE VALEURS / FORMAT
1..1
rpc_eic_code 1..1 Identifiant EIC du RPC string Texte
rpc_name 1..1 Nom du RPC string Texte
1
Les dates en retour sont exprimées en heure française (UTC + 2 heures en été, UTC 1 heure en hiver)
10Guide d’Utilisation API Certified Capacities Registry Version 1.1
Format JSON du retour :
GET /open_api/certified_capacities_registry/v1/ncc_greater_equal_100_mw
HTTP/1.1 200 OK
{"ncc_greater_equal_100_mw":[
{
"start_date":"2019-01-01T00:00:00+01:00",
"end_date":"2020-01-01T00:00:00+01:00",
"updated_date":"2015-06-01T00:00:00+02:00",
"edc":{"production_type":"GAS_COAL_HARD_COAL",
"code":"PTU000006",
"name":"3CB",
"network_connection":"TSO",
"type":"PRODUCTION",
"status":"OPERATING",
"certification_date":"2015-05-25T00:00:00+02:00"
},
"ncc":{"updated_ncc":0,"intial_ncc":175.8,"forecast_ncc":175.8},
"rpc":{"rpc_eic_code":"12XATEL-HANDEL-K","rpc_name":"ALPIQ Ltd"}
}
]
}
11Guide d’Utilisation API Certified Capacities Registry Version 1.1
4.1.1.4 Règles de gestion
Règle de gestion en fonction des paramètres d’entrée :
Paramètres en entrées
Description Numéro
start_date end_date
Si aucun paramètre d’entrée n’est renseigné, le Service NGE100M
vide vide retourne les EDC certifiées de la dernière année disponible. W-RG01
Si les champs start_date et end_date sont renseignés, NGE100M
renseigné renseigné le Service retourne les EDC certifiés sur cette période. W-RG02
Règles de gestion appliquées en sortie :
Numéro Description
NGE100MW- Les données de sortie sont triées par start_date de la plus récente à la plus ancienne
RG03 puis par EDC/name dans l’ordre alphabétique.
NGE100MW-
En sortie du Service, les EDC certifiées sont retournées à la maille année calendaire.
RG04
12Guide d’Utilisation API Certified Capacities Registry Version 1.1
4.1.1.5 Codes erreurs
Le tableau suivant liste les codes erreurs pouvant être retournés lors de l'appel à la ressource.
Le détail de ces erreurs est décrit au chapitre 5 Détails des erreurs.
Type d’erreur Code erreur Détails
Fonctionnelle CERTCAPAREGI_NCCGREEQU_F01 §5.1.1
Fonctionnelle CERTCAPAREGI_NCCGREEQU_F02 §5.1.1
Fonctionnelle CERTCAPAREGI_NCCGREEQU_F03 §5.1.1
Fonctionnelle CERTCAPAREGI_NCCGREEQU_F04 §5.1.1
Fonctionnelle CERTCAPAREGI_NCCGREEQU_F05 §5.1.1
Fonctionnelle CERTCAPAREGI_NCCGREEQU_F06 §5.1.1
Technique 401 §5.2
Technique 403 §5.2
Technique 404 §5.2
Technique 408 §5.2
Technique 413 §5.2
Technique 414 §5.2
Technique 429 §5.2
Technique 500 §5.2
Technique 503 §5.2
Technique 509 §5.2
13Guide d’Utilisation API Certified Capacities Registry Version 1.1
4.2 Ressource /ncc_less_100_mw
4.2.1 GET /ncc_less_100_mw
4.2.1.1 Modalités d’appel
La ressource est exposée de la manière suivante :
Exposition REST / JSON
Méthode GET
https://digital.iservices.rte-
URL ressource france.com/open_api/certified_capacities_registry/v1/ncc_less_100_mw?start_date=
&end_date=
https://digital.iservices.rte-
URL sandbox (1)
france.com/open_api/certified_capacities_registry/v1/sandbox/ncc_less_100_mw
(1)
La sandbox ne prend pas en compte les paramètres d’entrées
Préconisations d’appels
Cette ressource a pour objectif de permettre de récupérer un agrégat par filière des EDC dont le
niveau des capacités certifiées est inférieur à 100 MW. Dans le cas d’utilisation nominal, il n’est pas
nécessaire de renseigner les champs de la période. Le service retourne automatiquement les données
A+4 (année en cours + 4 ans).
Ce Service met à disposition des données à partir du 01/01/2017. Les données antérieures à cette
date ne sont pas disponibles.
Il est conseillé de faire un appel par jour à ce service et de ne pas dépasser une période de 6 années
par appel.
14Guide d’Utilisation API Certified Capacities Registry Version 1.1
4.2.1.2 Entrées
NOM CARD. DESCRIPTION TYPE VALEURS / FORMAT REGLES
Date de début des données YYYY-MM- NL100MW-RG01
start_date 0..1 date
demandées DDThh:mm:sszzzzzz1 NL100MW-RG02
Date de fin des données YYYY-MM- NL100MW-RG01
end_date 0..1 date
demandées DDThh:mm:sszzzzzz1 NL100MW-RG02
1
Les dates en paramètre peuvent être exprimées sur n’importe quel fuseau horaire
Exemple :
Sans paramètre
URL:
GET /open_api/certified_capacities_registry/v1/ncc_less_100_mw
HTTP/1.1 200 OK
Headers:
Host: digital.iservices.rte-france.com
Authorization: Bearer CNAPbfmg7GjvtqTTlKqPm8ykP6R8YJFfJPnyjqW8p1v2PW2UX6bF8z
Body:
Avec tous les paramètres
URL:
GET /open_api/certified_capacities_registry/v1/ncc_less_100_mw?start_date=2015-06-
08T00:00:00%2B02:00&end_date=2015-06-11T00:00:00%2B02:00
HTTP/1.1 200 OK
Headers:
Host: digital.iservices.rte-france.com
Authorization: Bearer CNAPbfmg7GjvtqTTlKqPm8ykP6R8YJFfJPnyjqW8p1v2PW2UX6bF8z
Body:
15Guide d’Utilisation API Certified Capacities Registry Version 1.1
4.2.1.3 Sorties
La structure ci-dessous est dupliquée et répétée pour chaque date de mise à jour de la prévision
demandée :
NOM CARD. DESCRIPTION
ncc_less_100_mw 1..1 Tableau de valeurs {JSON} structuré comme suit :
NOM CARD. DESCRIPTION TYPE VALEURS / FORMAT REGLES
NL100MW-RG03
YYYY-MM-
start_date 1..1 Date de début des données demandées date
DDThh:mm:sszzzzzz1 NL100MW-RG04
YYYY-MM- NL100MW-RG04
end_date 1..1 Date de fin des données demandées date
DDThh:mm:sszzzzzz1
YYYY-MM-
updated_date 1..1 Date de mise à jour de la donnée date
DDThh:mm:sszzzzzz1
edc Objet {JSON} structuré comme suit :
NOM CARD. DESCRIPTION TYPE VALEURS / FORMAT REGLES
Une des valeurs
suivantes :
OTHER
OTHER_RENEWABLE
BIOMASS
WASTES
DEMAND_RESPONSE
WIND_OFFSHORE
WINF_ONSHORE
HYDRO_RUN_OF_RIVER
_AND_POUNDAGE
0..n
GAS_ORIGINALY_FROM
1..1
NL100MW-RG03
Filière de l’Entité _COALl
production_type 1..1 enum
De Certification GAS_COAL_HARD_COAL
GEOTHERMAL
HYDRO_RESERVOIR
COAL_LIGNITE
MARINE
VARIOUS
NUCLEAR
FOSSIL_OIL
SHALE_OIL
HYDRO_PUMPED_STOR
AGE
SOLAR
PEAT
ncc Objet {JSON} structuré comme suit :
CARD
NOM DESCRIPTION TYPE VALEURS / FORMAT
.
Niveau de Capacité Certifiée évolué suite
1..1
updated_ncc 1..1 aux éventuelles demandes d’évolution de int Entier numérique
paramètre acordées (en Mw)
Niveau de Capacité Certifiée initial suite à la
intial_ncc 1..1 int Entier numérique
demande de certification (en Mw)
1
Les dates en retour sont exprimées en heure française (UTC + 2 heures en été, UTC 1 heure en hiver)
16Guide d’Utilisation API Certified Capacities Registry Version 1.1
Format JSON du retour :
GET /certified_capacities_registry/v1/ncc_less_100_mw/
HTTP/1.1 200 OK
{"ncc_less_100_mw":[
{
"start_date":"2020-01-01T00:00:00+01:00",
"end_date":"2021-01-01T00:00:00+01:00",
"updated_date":"2016-04-06T00:00:00+02:00",
"edc":{"production_type":"HYDRO_RUN_OF_RIVER_AND_POUNDAGE"},
"ncc":{"updated_ncc":0,"intial_ncc":1.7}
}
]
}
17Guide d’Utilisation API Certified Capacities Registry Version 1.1
4.2.1.4 Règles de gestion
Règle de gestion en fonction des paramètres d’entrée :
Paramètres en entrées
Description Numéro
start_date end_date
Si aucun paramètre d’entrée n’est renseigné, la ressource
retourne un agrégat d’EDC par filière dont le niveau de NL100MW-
vide vide
capacité certifiée est inférieur à 100 Mw pour la dernière RG01
année disponible.
Si les champs start_date et end_date sont renseignés, la
ressource retourne tous les agrégats d’EDC par filière dont NL100MW-
renseigné renseigné
le niveau de capacité certifiée est inférieur à 100 Mw de RG02
cette période.
Règles de gestion appliquées en sortie :
Numéro Description
NL100MW- Les données de sortie sont triées par start_date de la plus récente à la plus
RG03 ancienne puis par EDC/production_type par ordre alphabétique.
NL100MW- En sortie de la ressource, les agrégats d’EDC par filière dont le niveau de capacité
RG04 certifiée est inférieur à 100 Mw sont retournés à la maille année calendaire.
18Guide d’Utilisation API Certified Capacities Registry Version 1.1
4.2.1.5 Codes erreurs
Le tableau suivant liste les codes erreurs pouvant être retournés lors de l'appel à la ressource.
Le détail de ces erreurs est décrit au chapitre 5 Détails des erreurs.
Type d’erreur Code erreur Détails
Fonctionnelle CERTCAPAREGI_NCCLESS_F01 §5.1.2
Fonctionnelle CERTCAPAREGI_NCCLESS_F02 §5.1.2
Fonctionnelle CERTCAPAREGI_NCCLESS_F03 §5.1.2
Fonctionnelle CERTCAPAREGI_NCCLESS_F04 §5.1.2
Fonctionnelle CERTCAPAREGI_NCCLESS_F05 §5.1.2
Fonctionnelle CERTCAPAREGI_NCCLESS_F06 §5.1.2
Technique 401 §5.2
Technique 403 §5.2
Technique 404 §5.2
Technique 408 §5.2
Technique 413 §5.2
Technique 414 §5.2
Technique 429 §5.2
Technique 500 §5.2
Technique 503 §5.2
Technique 509 §5.2
19Guide d’Utilisation API Certified Capacities Registry Version 1.1
5 Détails des erreurs
Le schéma ci-dessous présente les codes retournés à l’Utilisateur de l’API en fonction du séquencement
des appels.
Ce paragraphe concerne les erreurs communes à toutes les ressources de l’API et à ce titre il ne décrit
pas les erreurs de requêtes (code http 400). Ces erreurs sont décrites ressource par ressource dans le
paragraphe correspondant.
En cas d’erreur lors de la phase d’authentification (validation du login et du mot de passe) un code
HTTP 401 « unauthorized » est retourné à l’appelant.
La seconde étape est de vérifier que l’Utilisateur ne dépasse pas le nombre maximal d’appels autorisés
pour l’opération. En cas de dépassement, l’appelant en est informé par un code HTTP 429. La réponse
du serveur contient dans ce cas un entête "Retry-After:" indiquant le temps d'attente (en secondes)
que le client doit attendre avant de renvoyer sa demande.
La troisième étape est de vérifier que l’application est bien créée/habilitée à accéder à la plateforme
technique VESPA. Si ce n’est pas le cas l’appelant en est informé par un code HTTP 403 « forbidden ».
La quatrième étape consiste à vérifier que l’application a bien souscrit à un abonnement à l’API. Si ce
n’est pas le cas, l’appelant en est informé par un code HTTP 403 « forbidden ».
La cinquième étape consiste à accéder aux ressources de RTE. Diverses erreurs fonctionnelles peuvent
se produire. Celles-ci sont communiquées à l’Utilisateur en tant qu’erreur JSON avec un code http 400.
En cas d’incident technique lors du traitement de la requête quelle que soit l’étape, l’appelant en sera
informé par un code HTTP 500.
20Guide d’Utilisation API Certified Capacities Registry Version 1.1
Structure JSON :
{
"error": "libelle_court, codification explicite de l’erreur",
"error_description": "libellé long, lisible par un utilisateur",
"error_uri": "URI vers le guide d’utilisation présent sur la plateforme technique VESPA ou la
FAQ/documentation sur le portail web de VESPA"
"error_details" : {
"transaction_id" : "identifiant unique d’appel, utile en cas d’incident"
}
}
Le libellé court (« error ») est un code permettant à l’application appelante de traiter
automatiquement les messages des erreurs. Il est représenté par une suite de mots séparés
par des « _ ».
Le libellé long (« error_description ») est une description permettant aux utilisateurs de
comprendre de façon plus précise l’origine de l’erreur. Ce libellé doit être validé par le métier
afin de s’assurer qu’il est suffisamment explicite.
L’URI vers le guide d’utilisation est présent pour donner plus d’explications en fonction de l’Api
appelée.
Le champ transaction_id : fournit un identifiant unique d’appel. Cet identifiant peut être
communiqué aux services d’assistance RTE en cas d’incident.
21Guide d’Utilisation API Certified Capacities Registry Version 1.1
5.1 Erreurs fonctionnelles
5.1.1 ncc_greater_equal_100_mw
Ce tableau récapitule les erreurs fonctionnelles retournées par la ressource correspondant à une erreur
dans la requête (code http 400) :
CERTCAPAREGI_NCCGREEQU_F01
Cette erreur est générée si les paramètres start_date et end_date sont passés l’un
RG
sans l’autre.
If one of the fields "start_date" or "end_date" is used, the two fields are mandatory.
Message
Please used either fields or neither.
GET
Exemple
open_api/certified_capacities_registry/v1/ncc_greater_equal_100_mw?start_date=2015
d'appel
-06-01T00:00:00%2B02:00
CERTCAPAREGI_NCCGREEQU_F02
Cette erreur est générée si le paramètre start_date est plus récent que le paramètre
RG
end_date.
The field "start_date" in the API input is more recently than the field "end_date". Please
Message
correct the values of these fields
GET
Exemple
open_api/certified_capacities_registry/v1/ncc_greater_equal_100_mw?start_date=2015
d'appel
-06-02T00:00:00%2B02:00&end_date=2015-06-01T00:00:00%2B02:00
CERTCAPAREGI_NCCGREEQU_F03
RG Cette erreur est générée si la période demandée est supérieure à 6 années.
The API does not provide feedback on such a long period in one call. To retrieve all the
Message
data please make it with severals calls to the API.
GET
Exemple
open_api/certified_capacities_registry/v1/ncc_greater_equal_100_mw?start_date=2015
d'appel
-06-01T00:00:00%2B02:00&end_date=2022-06-01T00:00:00%2B02:00
CERTCAPAREGI_NCCGREEQU_F04
Cette erreur est générée si end_date est supérieur au premier janvier de A+6 par
RG
rapport à la date système
Message The value of "end_date" field is incorrect. It is not possible to recover data to this term.
GET
Exemple open_api/certified_capacities_registry/v1/ncc_greater_equal_100_mw?type=REALISED
d'appel &start_date=2015-10-31T00:00:00%2B02:00&end_date=2021-11-
09T00:00:00%2B02:00
CERTCAPAREGI_NCCGREEQU_F05
Cette erreur est générée si l’intervalle de temps entre start_date et end_date est
RG
inférieur 1 an calendaire.
The period filled by fields "start_date" and "end_date" is too short to return values. Please
Message
check the user guide to verify the minimum period for this API.
GET
Exemple
open_api/certified_capacities_registry/v1/ncc_greater_equal_100_mw?start_date=2015
d'appel
-06-01T00:00:00%2B02:00&end_date=2015-06-01T12:00:00%2B02:00
CERTCAPAREGI_NCCGREEQU_F06
Cette erreur est générée si au moins un des paramètres start_date ou end_date n’a
RG
pas le format attendu
One of the dates in the API input does not follow the format described in the user guide.
Message
Please verify compliance with the format for each field.
22Guide d’Utilisation API Certified Capacities Registry Version 1.1
GET
Exemple
open_api/certified_capacities_registry/v1/ncc_greater_equal_100_mw?start_date=2015
d'appel
-06-01&end_date=2015-06-01
5.1.2 ncc_less_100_mw
Ce tableau récapitule les erreurs fonctionnelles retournées par la ressource correspondant à une erreur
dans la requête (code http 400) :
CERTCAPAREGI_NCCLESS_F01
Cette erreur est générée si les paramètres start_date et end_date sont passés l’un sans
RG
l’autre.
If one of the fields "start_date" or "end_date" is used, the two fields are mandatory. Please
Message
used either fields or neither.
Exemple GET open_api/certified_capacities_registry/v1/ncc_less_100_mw?start_date=2015-06-
d'appel 01T00:00:00%2B02:00
CERTCAPAREGI_NCCLESS_F02
Cette erreur est générée si le paramètre start_date est plus récent que le paramètre
RG
end_date.
The field "start_date" in the API input is more recently than the field "end_date". Please
Message
correct the values of these fields
Exemple GET open_api/certified_capacities_registry/v1/ncc_less_100_mw?start_date=2015-06-
d'appel 02T00:00:00%2B02:00&end_date=2015-06-01T00:00:00%2B02:00
CERTCAPAREGI_NCCLESS_F03
RG Cette erreur est générée si la période demandée est supérieure à 6 années.
The API does not provide feedback on such a long period in one call. To retrieve all the
Message
data please make it with severals calls to the API.
Exemple GET open_api/certified_capacities_registry/v1/ncc_less_100_mw?start_date=2013-06-
d'appel 01T00:00:00%2B02:00&end_date=2020-06-01T12:00:00%2B02:00
CERTCAPAREGI_NCCLESS_F04
Cette erreur est générée si end_date est supérieur au 1er Janvier de A+6 par rapport à
RG
la date système
Message The value of "end_date" field is incorrect. It is not possible to recover data to this term.
GET open_api/certified_capacities_registry/v1/ncc_less_100_mw?start_date=2015-10-
Exemple
d'appel 31T00:00:00%2B02:00&end_date=2015-11-09T00:00:00%2B02:00
Pour un appel le 30/10/2015
CERTCAPAREGI_NCCLESS_F05
Cette erreur est générée si l’intervalle de temps entre start_date et end_date est
RG
inférieur 1 an calendaire.
The period filled by fields "start_date" and "end_date" is too short to return values. Please
Message
check the user guide to verify the minimum period for this API.
Exemple GET open_api/certified_capacities_registry/v1/ncc_less_100_mw?start_date=2015-06-
d'appel 01T00:00:00%2B02:00&end_date=2015-06-01T12:00:00%2B02:00
CERTCAPAREGI_NCCLESS_F06
Cette erreur est générée si au moins un des paramètres start_date ou end_date n’a pas
RG
le format attendu
One of the dates in the API input does not follow the format described in the user guide.
Message
Please verify compliance with the format for each field.
Exemple GET open_api/certified_capacities_registry/v1/ncc_less_100_mw?start_date=2015-06-
d'appel 01&end_date=2015-06-01
23Guide d’Utilisation API Certified Capacities Registry Version 1.1
5.2 Erreurs techniques
401
Code http 401
Message unauthorized
Description Erreur générée lorsque l’authentification a échouée
403
Code http 403
Message Forbidden
Description Erreur générée si l’appelant n’est pas habilité à appeler la ressource
404
Code http 404
Message Not Found
Description La ressource appelée n’existe pas ou aucune page n’a été trouvée
408
Code http 408
Message Request Time-out
Erreur générée sur non réponse du service appelé ou retour en timeout (http
Description
408) du service appelé.
413
Code http 413
Message Request Entity Too Large
Description La taille de la réponse de la requête dépasse 7Mo
414
Code http 414
Message Request-URI Too Long
Description L’URI transmise par l’appelant dépasse 2048 caractères.
429
Code http 429
Message Too Many Requests
Description Le nombre d’appel maximum dans un certain laps de temps est dépassé.
500
Code http 500
Message Internal Server Error
Toute autre erreur technique.
Description (Cette erreur est accompagnée d’un message JSON avec un champ error_code
et error_description)
24Guide d’Utilisation API Certified Capacities Registry Version 1.1
503
Code http 503
Message Service Unavailable
Description Erreur générée sur maintenance (http 503).
509
Code http 509
Message Bandwidth Limit Exceeded.
Description L‘ensemble des requêtes des clients atteint la limite maximale.
25Guide d’Utilisation API Certified Capacities Registry Version 1.1
6 Annexes
6.1 Fichiers Exemples
Une fois l’Utilisateur connecté sur le Portail Data, des exemples de fichiers (notamment les réponses
de l’API) sont disponibles en ligne avec le descriptif de l'API.
FIN DU DOCUMENT
26Vous pouvez aussi lire
