Skip to content

Commit 8d0ae8f

Browse files
committed
Proofreading
1 parent a076ef2 commit 8d0ae8f

File tree

6 files changed

+38
-34
lines changed

6 files changed

+38
-34
lines changed

pages/account/api/console-preview/guide.fr-fr.md

Lines changed: 36 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,19 @@
11
---
2-
title: 'Exploration des APIs OVHcloud'
3-
slug: ovh-api-exploration
4-
excerpt: 'Découvrez comment explorer les APIs OVHcloud'
2+
title: 'Exploration des API OVHcloud'
3+
slug: api-console-exploration
4+
excerpt: 'Découvrez comment explorer les API OVHcloud'
55
section: 'Premiers pas'
6-
updated: 2023-03-16
6+
order: 02
7+
updated: 2023-03-24
78
---
89

9-
**Dernière mise à jour le 16/03/2023**
10+
**Dernière mise à jour le 24/03/2023**
1011

1112
## Objectif
1213

13-
Les APIs disponibles sur [https://eu.api.ovh.com/](https://eu.api.ovh.com/){.external} vous permettent d'acheter, gérer, mettre à jour et configurer des produits OVHcloud sans utiliser une interface graphique comme l'espace client.
14+
Les API disponibles sur [https://eu.api.ovh.com/](https://eu.api.ovh.com/){.external} vous permettent d'acheter, gérer, mettre à jour et configurer des produits OVHcloud sans utiliser une interface graphique comme l'espace client.
1415

15-
**Découvrez comment explorer les API OVHcloud à travers notre nouvelle console**
16+
**Découvrez comment explorer les API OVHcloud à travers notre nouvelle console.**
1617

1718
## Prérequis
1819

@@ -25,43 +26,41 @@ Les APIs disponibles sur [https://eu.api.ovh.com/](https://eu.api.ovh.com/){.ext
2526
>
2627
> OVHcloud met à votre disposition des services dont la configuration, la gestion et la responsabilité vous incombent. Il vous revient de ce fait d'en assurer le bon fonctionnement.
2728
>
28-
> Nous mettons à votre disposition ce guide afin de vous accompagner au mieux sur des tâches courantes. Néanmoins, nous vous recommandons de faire appel à un [prestataire spécialisé](https://partner.ovhcloud.com/fr/) et/ou de contacter l'éditeur du service si vous éprouvez des difficultés. En effet, nous ne serons pas en mesure de vous fournir une assistance. Plus d'informations dans la section « [Aller plus loin ](#gofurther) » de ce guide.
29+
> Nous mettons à votre disposition ce guide afin de vous accompagner au mieux sur des tâches courantes. Néanmoins, nous vous recommandons de faire appel à un [prestataire spécialisé](https://partner.ovhcloud.com/fr/directory/) et/ou de contacter l'éditeur du service si vous éprouvez des difficultés. En effet, nous ne serons pas en mesure de vous fournir une assistance. Plus d'informations dans la section « [Aller plus loin ](#gofurther) » de ce guide.
2930
>
3031
32+
### Se connecter aux API OVHcloud
3133

32-
### Utilisation simple
33-
34-
#### Se connecter aux API OVHcloud
35-
36-
Sur la page des [APIs OVHcloud](https://eu.api.ovh.com/), cliquez sur `Try the new OVHcloud API console`{.action} pour afficher la liste des APIs.
34+
Sur la page des [API OVHcloud](https://eu.api.ovh.com/), cliquez sur `Try the new OVHcloud API console`{.action} pour afficher la liste des API.
3735

3836
Pour utiliser les API sur vos produits, vous devez vous connecter sur ce site grâce à vos identifiants OVHcloud.
3937

4038
- Cliquez sur `Authentication`{.action} en haut à gauche.
41-
- L'authentification utilise le protocole OAuth2 et un système de scopes. Pour vous authentifier, vous devez choisir un ou plusieurs scope(s) parmi la liste proposée. Ceux-ci limiteront l'accès du token généré à une sous-partie des opérations de l'API. Pour ce tutoriel, sélectionnez simplement le scope "all" qui donne accès à toutes les opérations de l'API, puis cliquez sur le bouton `GET TOKEN`.
39+
- L'authentification utilise le protocole OAuth2 et un système de scopes. Pour vous authentifier, vous devez choisir un ou plusieurs scope(s) parmi la liste proposée. Ceux-ci limiteront l'accès du token généré à une sous-partie des opérations de l'API. Pour ce tutoriel, sélectionnez simplement le scope `all` qui donne accès à toutes les opérations de l'API, puis cliquez sur le bouton `GET TOKEN`{.action}.
4240
- Vous serez alors redirigé vers la page d'authentification sur laquelle vous devez saisir vos identifiants OVHcloud.
4341
- Une fois vos identifiants validés, vous serez redirigé sur la console et pourrez essayer des appels sur les routes de l'API OVHcloud.
4442

4543
![API](images/authentication.png){.thumbnail}
4644

4745
> [!primary]
4846
>
49-
> Si votre compte OVHcloud est protégé par une [double authentification](https://docs.ovh.com/fr/customer/securiser-son-compte-avec-une-2FA/), vous devrez également saisir le code généré par SMS ou application OTP ou clé U2F.
47+
> Si votre compte OVHcloud est protégé par une [double authentification](https://docs.ovh.com/fr/customer/securiser-son-compte-avec-une-2FA/), vous devrez également saisir le code généré par SMS ou application OTP ou clé U2F.
5048
>
5149
52-
#### Explorer les produits disponibles sur les APIs
50+
### Explorer les produits disponibles sur les API
5351

54-
##### Sélection de la branche d'API
52+
#### Sélection de la branche d'API
53+
54+
Plusieurs branches des API OVHcloud sont disponibles :
5555

56-
Plusieurs branches des APIs OVHcloud sont disponibles :
5756
- **V1** : l'API disponible à l'URL [https://eu.api.ovh.com/v1](https://eu.api.ovh.com/v1)
5857
- **V2** : la nouvelle API OVHcloud, disponible à l'URL [https://eu.api.ovh.com/v2](https://eu.api.ovh.com/v2)
5958

6059
La branche d'API peut être sélectionnée à l'aide du menu déroulant en haut à gauche de la console.
6160

6261
![API](images/api-branches.png){.thumbnail}
6362

64-
##### Selection de la section d'API
63+
#### Selection de la section d'API
6564

6665
Après avoir choisi la branche d'API, vous pouvez naviguer dans les différentes sections de la branche sélectionnée. Par défaut, la première section dans l'ordre alphabétique est sélectionnée.
6766
Les sections sont disponibles dans le menu déroulant à droite du menu permettant de choisir la branche. Il est possible de filtrer la liste des sections en commençant à taper le nom de la section recherchée.
@@ -70,13 +69,14 @@ Les sections sont disponibles dans le menu déroulant à droite du menu permetta
7069

7170
Une fois une section sélectionnée, la liste des opérations qu'elle contient est affichée dans le menu de gauche.
7271

73-
##### Exploration des opérations
72+
#### Exploration des opérations
7473

7574
La liste des opérations de la section d'API sélectionnée est visible dans la partie basse du menu de gauche.
7675

7776
![API](images/api-operations.png){.thumbnail}
7877

7978
Chaque ligne contient les informations suivantes :
79+
8080
- Le verbe HTTP de l'operation (GET, PUT, POST, PATCH, DELETE)
8181
- Le nom de la route
8282
- L'état de l'opération : si l'opération est en état *alpha* ou *beta*, vous pourrez observer un badge sur la droite du nom de la route.
@@ -91,34 +91,35 @@ Une fois que vous aurez sélectionné une opération, les informations de celle-
9191

9292
Cette vue est découpée en quatre parties décrites ci-après.
9393

94-
###### Informations générales
94+
##### **Informations générales**
9595

9696
Cette partie contient les informations générales à propos de l'opération d'API :
97+
9798
- L'état de l'opération (par exemple *Beta version*)
9899
- La description de l'opération
99100
- Le nom de la route et le verbe HTTP de l'opération
100101

101102
![API](images/operation-information.png){.thumbnail}
102103

103-
###### Requête
104+
##### **Requête**
104105

105106
Cette partie décrit les paramètres d'entrée de l'opération. Selon l'opération, plusieurs sous-sections vont être affichées :
106107

107-
**Paramètres de chemin**
108+
- **Paramètres de chemin**
108109

109110
![API](images/operation-path-parameter.png){.thumbnail}
110111

111112
L'étoile rouge située sur la gauche du nom du paramètre indique que celui-ci est obligatoire pour pouvoir exécuter la requête.
112113

113-
**Paramètres d'en-tête**
114+
- **Paramètres d'en-tête**
114115

115116
![API](images/operation-header-parameter.png){.thumbnail}
116117

117-
**Paramètres de requête**
118+
- **Paramètres de requête**
118119

119120
![API](images/operation-query-parameter.png){.thumbnail}
120121

121-
**Corps de la requête**
122+
- **Corps de la requête**
122123

123124
Cette zone permet de décrire les paramètres du corps de la requête. La vue par défaut montre un exemple de ce que l'opération accepte pour ces paramètres.
124125
Ces valeurs peuvent être modifiées directement dans cette vue pour pouvoir tester l'appel avec des valeurs correspondantes à vos services.
@@ -129,7 +130,7 @@ Il existe aussi un onglet *SCHEMA* qui vous permet de visualiser plus précisém
129130

130131
![API](images/operation-request-schema.png){.thumbnail}
131132

132-
###### Réponse
133+
##### **Réponse**
133134

134135
Cette section est similaire à la précédente et présente un exemple de réponse de l'API.
135136

@@ -139,32 +140,34 @@ L'onglet *SCHEMA* est également disponible pour avoir le détail des champs ret
139140

140141
![API](images/operation-response-schema.png){.thumbnail}
141142

142-
##### Recherche avancée
143+
#### Recherche avancée
143144

144-
Une recherche avancée est disponible en cliquant sur le bouton `Search` en haut à gauche.
145+
Une recherche avancée est disponible en cliquant sur le bouton `Search`{.action} en haut à gauche.
145146

146147
![API](images/api-advance-search.png){.thumbnail}
147148

148-
Une fenêtre de recherche avancée s'ouvre et permet de rechercher suivants les critères suivants :
149+
Une fenêtre de recherche avancée s'ouvre et permet de rechercher suivant les critères suivants :
150+
149151
- Nom de la route d'API
150152
- Description de la route d'API
151153
- Paramètres de l'opération
152-
- Champs du corps de la requête de l'opération
154+
- Champ du corps de la requête de l'opération
153155
- Description de la réponse de l'opération
154156
- État de l'opération
155157

156158
![API](images/api-advance-search-popup.png){.thumbnail}
157159

158-
#### Exécuter des requêtes
160+
### Exécuter des requêtes
159161

160-
Depuis la console, il est possible d'interagir directement avec l'API en utilisant le bouton `TRY`.
162+
Depuis la console, il est possible d'interagir directement avec l'API en utilisant le bouton `TRY`{.action}.
161163

162164
![API](images/operation-try-call.png){.thumbnail}
163165

164166
Après avoir rempli (si nécessaire) les paramètres requis pour une opération, ce bouton permet de faire un vrai appel à l'API OVHcloud.
165167
La réponse sera ensuite affichée en dessous des paramètres de l'opération.
166168

167169
Trois onglets sont disponibles dans cette vue :
170+
168171
- **RESPONSE** : le corps de la réponse renvoyée par l'API
169172
- **RESPONSE HEADERS** : les en-têtes renvoyés par l'API
170173
- **CURL** : montre l'équivalent de la requête envoyée à l'API en utilisant l'utilitaire `curl`
-3 KB
Loading
-11.4 KB
Loading
-61.4 KB
Loading
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
id: 41e485da-0303-4a32-9e7e-3fcdd04c30f1
2-
full_slug: ovh-api-exploration
2+
full_slug: api-console-exploration

pages/account/api/first-steps/guide.fr-fr.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ title: 'Premiers pas avec les API OVHcloud'
33
slug: first-steps-with-ovh-api
44
excerpt: 'Découvrez comment utiliser les API OVHcloud'
55
section: 'Premiers pas'
6+
order: 01
67
updated: 2022-05-30
78
---
89

0 commit comments

Comments
 (0)