API publique : on fait le point

22 Avr, 2021  - écrit par  dans Le Bar de Gandi

Voilà déjà un moment que nous n’avons pas fait le point sur la version bêta de notre API publiques V5, justement car nous étions occupés à travailler dessus. Si vous ne l’avez pas consultée depuis quelques temps, et bien qu’il s’agisse toujours d’une version bêta (voir ci-dessous), sachez qu’elle a été considérablement étoffée et que nous vous apporté un certain nombre d’améliorations tant sur l’API que sur sa documentation.

À vos blocs-notes, on vous explique tout ci-dessous.

C’est quoi cette API publique ?

Lors de la présentation de Gandi V5 en 2018, nous vous dévoilions un nouveau design d’interface, mais aussi et surtout une toute nouvelle plateforme de gestion des noms de domaine. Notre approche était de proposer dans un premier temps un produit viable, puis de développer des fonctionnalités avancées au fil du temps.

La version bêta de l’API publique a été un projet à long terme découlant de cette refonte complète qui offre des outils puissants et une plus grande souplesse d’utilisation.

Quelles sont les nouveautés ?

Après une année à travailler sur ce projet, nous sommes aujourd’hui heureux de pouvoir proposer une version bêta de notre API publique qui couvre une grande diversité de besoins.

D’une manière plus exhaustive, voici les services désormais couverts :

  • Domain API : ces méthodes couvrent l’enregistrement, le renouvellement, le transfert et les mises à jour des contacts.
  • LiveDNS API : ces méthodes couvrent les mises à jour des fichiers de zone DNS.
  • Templates API : ces méthodes couvrent la création de modèles de configuration qui peuvent être appliqués soit en masse à un grand nombre noms de domaine, soit lors de l’achat d’un nom de domaine.
  • Email API : ces méthodes s’appliquent à la création et à la gestion de boîtes mails avec le service GandiMail de Gandi (incluant 2 boîtes mails gratuites avec 3 Go de stockage par nom de domaine).
  • Organizations API : ces méthodes concernent la gestion des utilisateurs et des permissions.
  • Billing API : ces méthodes concernent le paiement, notamment le crédit automatique et le solde du compte prépayé.
  • Certificates API : ces méthodes couvrent la création et la gestion des certificats SSL.
  • Simple Hosting : ces méthodes concernent la gestion des applications, des instances et des vhosts Simple Hosting.

Pour plus d’informations, n’hésitez pas à consulter notre documentation API.

Pour une vision plus précise des modifications et mises à jour récentes, nous vous recommandons notre changelog

Et maintenant ?

Notre API publique a déjà connu de belles avancées, et vous pouvez vous attendre à encore beaucoup de mises à jour passionnantes.

En finir avec la version bêta

Bien que les méthodes existantes dans notre API publique soient toutes 100% sûres à utiliser, nous la conservons en bêta jusqu’à ce que nous puissions assurer une couverture encore meilleure. Ce qui existe est cependant parfaitement utilisable dans les environnements de production. Outre l’ajout de nouvelles méthodes, le maintien de l’API en version bêta nous donne l’occasion de continuer à apporter des modifications mineures aux méthodes existantes.

Dans un premier temps, nous voulons notamment nous assurer que nous étendons davantage notre couverture et que les signatures existantes ne changeront pas, mais aussi ajouter des annexes à la documentation (notamment une liste d’extra paramètres par TLD et une liste de codes de pays) avant de retirer l’étiquette « bêta ».

Introduire un environnement Sandbox

Avant la fin de l’année, nous espérons également introduire un environnement Sandbox. Cela permettra aux utilisateurs d’API de tester plus efficacement les applications qui s’appuient sur notre API en simulant les réponses API de production et en réduisant ainsi le risque et le coût des tests avec des produits et services en direct.

Améliorer de la documentation

Une autre de nos volontés est d’améliorer la documentation de notre API via :

  • L’ajout d’annexes (une des conditions mentionnées ci-dessus pour la sortir de la bêta),
  • L’ajout de cas d’utilisation.

De futures améliorations selon vos besoins

Depuis toujours, nous vous invitons à prendre la parole pour nous faire part de vos retours d’expérience. C’est grâce à ces contributions que nos équipes peuvent assurer l’amélioration de nos produits. Vos commentaires sont véritablement essentiels et constituent un élément indispensable de notre processus de développement.
L’API publique ne fait pas exception à cette règle et c’est pourquoi nous voulons votre avis!

Plus nous recevons de commentaires, plus nous pouvons améliorer l’API et la documentation ! Alors n’hésitez pas à nous contacter.

Et si vous souhaitez utiliser notre API pour un projet spécifique et que vous avez besoin d’aide, nous sommes à votre disposition pour vous guider. Il suffit de fournir une description rapide et quelques détails sur votre projet via le formulaire de contact sur notre page d’aide : https://help.gandi.net/fr/contact/api.

Laisser un commentaire