API de la Data Platform
L'authentification aujourd'hui, le reste de la platform au fur et à mesure de sa sortie.
Ce que couvrent les API
Les API de la Data Platform sont l'alternative programmatique à l'interface, pour construire et gérer un projet en code plutôt qu'à la main.
L'API complète de la Data Platform est en cours de développement. Ce que cette section documente aujourd'hui est l'authentification : comment obtenir un token par mot de passe ou par identifiants de clé API, et comment l'invalider. Les références de endpoints pour le reste de la platform arriveront ici au fur et à mesure de leur sortie.
En attendant, deux autres voies couvrent la majorité du travail programmatique. Le Custom Actions SDK lit et écrit des datasets, des tables et des buckets depuis le compute propre d'un projet. Les buckets du projet parlent S31, donc n'importe quel client compatible S3 fonctionne directement contre eux, comme le montre le tutoriel d'accès aux buckets.
Les conventions ci-dessous s'appliquent aux endpoints d'authentification et à l'API au fur et à mesure de sa croissance.
Formats généraux
Format de réponse
- Format des données : JSON, voir http://www.json.org
- Jeu de caractères : UTF-8
- Toutes les réponses non vides sont envoyées avec l'en-tête :
Content-Type: application/json; charset=utf-8
Codes de réponse HTTP
Gestion des erreurs
En cas d'erreur côté client (code HTTP 4xx) ou côté serveur (code HTTP 5xx), le corps de la réponse peut contenir un objet JSON décrivant l'erreur :
Timestamp
Tous les endpoints de données renvoient le timestamp associé aux données fournies.
Durée
Tous les endpoints de données renvoient l'attribut duration. Il représente le temps effectif pris par le système pour exécuter une requête, en secondes.
Aller plus loin
Si vous avez besoin d'une formation ou d'une assistance technique pour la mise en oeuvre de nos solutions, contactez votre commercial ou cliquez sur ce lien pour obtenir un devis et demander une analyse personnalisée de votre projet à nos experts de l’équipe Professional Services.
Posez vos questions, faites-nous part de vos commentaires et interagissez directement avec l’équipe qui développe la Data Platform sur le canal Discord dédié.
Si vous avez besoin d'une assistance concernant vos services OVHcloud, créez une demande depuis notre centre d'aide.
Rejoignez notre communauté d'utilisateurs.
1 : S3 est une marque déposée appartenant à Amazon Technologies, Inc. Les services de OVHcloud ne sont pas sponsorisés, approuvés, ou affiliés de quelque manière que ce soit.