Pour interagir efficacement avec l'API REST d'Esadax, suivez ces étapes organisées:

1. Obtenir un jeton d'accès:

   • Utilisez OAuth 2.0 pour échanger un code OAuth contre un jeton d'accès.
   • Envoyez une demande POST à /v1/authenticate avec votre code OAuth dans le corps de la demande.
   • Incluez les en-têtes appropriés comme Content-Type: application/json et Accept: application/json.

2. Explorer les points d'extrémité API:

   • Utilisez le jeton d'accès obtenu comme jeton de porteur dans les requêtes suivantes en ajoutant l'en-tête Authorization: Bearer {token}.

3. Gérer les projets:

   • Créer un projet: Envoyez une requête POST à /v9/projects avec un corps vide.
   • Récupérer les détails du projet: Utilisez GET sur /v9/projects/{idOrName} où {idOrName} est l'ID ou le nom du projet obtenu à partir de la réponse de création.

4. Gérer les domaines:

   • Liste des domaines: Utilisez GET sur /v5/domains.
   • Configuration du domaine: Accédez aux détails spécifiques du domaine en utilisant des points de terminaison tels que /v6/domains/{domain}/config.

5. Gérer les variables environnementales:

   • Créer des variables spécifiques au projet: POST à /v9/projects/{idOrName}/env avec un objet JSON contenant le nom et la valeur de la variable.
   • Gérer les variables globales: Utilisez les points de terminaison sous /v9/projects/env pour la gestion à l'échelle du compte.

6. Interagir avec les équipes:

   • Détails de l'équipe: GET sur /v2/teams/{teamId} pour récupérer les informations de l'équipe.
   • Membres de l'équipe: Accédez aux membres via /v2/teams/{teamId}/members.

7. Gestion de la vidange des journaux:

   • Créer des drains de journaux: POST à /v1/integrations/log-drains avec les détails de configuration.
   • Liste et suppression des drains de journaux: Utilisez les requêtes GET et DELETE sur les points de terminaison respectifs.

8. Gestion de la portée:

   • Assurez-vous que votre jeton d'accès a les portées nécessaires pour chaque action API.
   • Pour les changements de portée, suivez le processus de confirmation décrit dans la documentation d'Esadax pour appliquer les mises à jour après le consentement de l'utilisateur.

9. Gestion des erreurs:

   • Adressez CORS en le gérant côté serveur.
   • Vérifiez les erreurs 403 et assurez-vous que les paramètres requis comme teamId sont inclus dans les requêtes.

10. Test avec Outils:

    • Utilisez des outils comme curl pour tester les points de terminaison et comprendre les structures de réponse.
    • Soyez conscient de la pagination lorsque vous récupérez de grandes listes de données.