You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: pages/account/api/console-preview/guide.fr-fr.md
+36-33Lines changed: 36 additions & 33 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,18 +1,19 @@
1
1
---
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'
5
5
section: 'Premiers pas'
6
-
updated: 2023-03-16
6
+
order: 02
7
+
updated: 2023-03-24
7
8
---
8
9
9
-
**Dernière mise à jour le 16/03/2023**
10
+
**Dernière mise à jour le 24/03/2023**
10
11
11
12
## Objectif
12
13
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.
14
15
15
-
**Découvrez comment explorer les API OVHcloud à travers notre nouvelle console**
16
+
**Découvrez comment explorer les API OVHcloud à travers notre nouvelle console.**
16
17
17
18
## Prérequis
18
19
@@ -25,43 +26,41 @@ Les APIs disponibles sur [https://eu.api.ovh.com/](https://eu.api.ovh.com/){.ext
25
26
>
26
27
> 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.
27
28
>
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.
29
30
>
30
31
32
+
### Se connecter aux API OVHcloud
31
33
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.
37
35
38
36
Pour utiliser les API sur vos produits, vous devez vous connecter sur ce site grâce à vos identifiants OVHcloud.
39
37
40
38
- 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}.
42
40
- Vous serez alors redirigé vers la page d'authentification sur laquelle vous devez saisir vos identifiants OVHcloud.
43
41
- Une fois vos identifiants validés, vous serez redirigé sur la console et pourrez essayer des appels sur les routes de l'API OVHcloud.
44
42
45
43
{.thumbnail}
46
44
47
45
> [!primary]
48
46
>
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.
50
48
>
51
49
52
-
####Explorer les produits disponibles sur les APIs
50
+
### Explorer les produits disponibles sur les API
53
51
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 :
55
55
56
-
Plusieurs branches des APIs OVHcloud sont disponibles :
57
56
-**V1** : l'API disponible à l'URL [https://eu.api.ovh.com/v1](https://eu.api.ovh.com/v1)
58
57
-**V2** : la nouvelle API OVHcloud, disponible à l'URL [https://eu.api.ovh.com/v2](https://eu.api.ovh.com/v2)
59
58
60
59
La branche d'API peut être sélectionnée à l'aide du menu déroulant en haut à gauche de la console.
61
60
62
61
{.thumbnail}
63
62
64
-
#####Selection de la section d'API
63
+
#### Selection de la section d'API
65
64
66
65
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.
67
66
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
70
69
71
70
Une fois une section sélectionnée, la liste des opérations qu'elle contient est affichée dans le menu de gauche.
72
71
73
-
#####Exploration des opérations
72
+
#### Exploration des opérations
74
73
75
74
La liste des opérations de la section d'API sélectionnée est visible dans la partie basse du menu de gauche.
76
75
77
76
{.thumbnail}
78
77
79
78
Chaque ligne contient les informations suivantes :
79
+
80
80
- Le verbe HTTP de l'operation (GET, PUT, POST, PATCH, DELETE)
81
81
- Le nom de la route
82
82
- 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-
91
91
92
92
Cette vue est découpée en quatre parties décrites ci-après.
93
93
94
-
###### Informations générales
94
+
#####**Informations générales**
95
95
96
96
Cette partie contient les informations générales à propos de l'opération d'API :
97
+
97
98
- L'état de l'opération (par exemple *Beta version*)
98
99
- La description de l'opération
99
100
- Le nom de la route et le verbe HTTP de l'opération
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.
124
125
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
0 commit comments