Para interactuar con la API REST de Esadax de manera efectiva, siga estos pasos organizados:
- Obtener un token de acceso:
- Usa OAuth 2.0 para intercambiar un código OAuth por un token de acceso.
- Envía una solicitud POST a
/v1/authenticatecon tu código OAuth en el cuerpo de la solicitud. - Incluye encabezados apropiados como
Content-Type: application/jsonyAccept: application/json.
- Explore los puntos finales de API:
- Utilice el token de acceso obtenido como token de portador en solicitudes posteriores agregando el encabezado
Authorization: Bearer {token}.
- Utilice el token de acceso obtenido como token de portador en solicitudes posteriores agregando el encabezado
- Gestionar proyectos:
- Crear un Proyecto: Enviar una solicitud POST a
/v9/projectscon un cuerpo vacío. - Recupere los detalles del proyecto: Use GET en
/v9/projects/{idOrName}donde{idOrName}es el ID o nombre del proyecto obtenido de la respuesta de creación.
- Crear un Proyecto: Enviar una solicitud POST a
- Administrar dominios:
- Lista de dominios: Use GET en
/v5/domains. - Configuración de dominio: Acceda a detalles específicos del dominio utilizando puntos finales como
/v6/domains/{domain}/config.
- Lista de dominios: Use GET en
- Manejo de variables ambientales:
- Crear variables específicas del proyecto: POST a
/v9/projects/{idOrName}/envcon un objeto JSON que contiene el nombre y el valor de la variable. - Administrar variables globales: Usa puntos finales bajo
/v9/projects/envpara la administración de toda la cuenta.
- Crear variables específicas del proyecto: POST a
- Interactúa con los equipos:
- Detalles del equipo: GET en
/v2/teams/{teamId}para recuperar la información del equipo. - Miembros del equipo: Acceda a los miembros a través de
/v2/teams/{teamId}/members.
- Detalles del equipo: GET en
- Gestión de drenaje de registro:
- Crear drenajes de registro: POST a
/v1/integrations/log-drainscon los detalles de configuración. - Enumerar y eliminar drenajes de registros: Use solicitudes GET y DELETE en los puntos finales respectivos.
- Crear drenajes de registro: POST a
- Gestión del alcance:
- Asegúrese de que su token de acceso tenga los alcances necesarios para cada acción de API.
- Para cambios de alcance, siga el proceso de confirmación descrito en la documentación de Esadax para aplicar actualizaciones después del consentimiento del usuario.
- Manejo de errores:
- Aborda CORS manejándolo en el lado del servidor.
- Compruebe si hay errores 403 y asegúrese de que los parámetros necesarios, como
teamId, se incluyan en las solicitudes.
- Prueba con Herramientas:
- Utilice herramientas como curl para probar puntos finales y comprender las estructuras de respuesta.
- Tenga en cuenta la paginación al obtener grandes listas de datos.
