Documentación / Recursos Avançados
Recursos Avançados

Como Autenticarse en la API (Generar el Token de Acceso)

Generar el Token

Resumen

La API de la plataforma eAgenda requiere autenticacion para acceder a sus endpoints, utilizando principalmente el metodo HTTP Bearer con un token de acceso. Esta guia practica detalla como generar el token de acceso desde el panel de eAgenda y usarlo en solicitudes HTTP. Para mas informacion, consulte la documentacion oficial de la API de eAgenda.

Preparacion del Entorno

Antes de comenzar, necesitara:

  • Credenciales de acceso: Cuenta con usuario y contrasena validos en el panel de eAgenda (ej.: correo electronico como teste@eagenda.com).
  • Acceso al panel: Navegador web para acceder al panel de eAgenda en https://eagenda.com.br.
  • Herramienta para solicitudes HTTP: Use cURL, Postman o bibliotecas como requests (Python) o axios (JavaScript) para probar la autenticacion.

Nota: Este tutorial se enfoca en la autenticacion via Bearer Token, que es el metodo mas comun para APIs. Otros metodos, como HTTP Basic o cookie (__Secure-sessionid), no se cubren aqui, pero pueden explorarse en la documentacion.

Paso a Paso para Generar el Token de Acceso

Para obtener o generar el token de acceso vea el tutorial completo aqui, o siga los pasos a continuacion en el panel de eAgenda:

  1. Acceda al panel de eAgenda:
  2. Navegue hasta la seccion de integraciones:
    • En el menu lateral izquierdo, haga clic en Integraciones.
  3. Acceda a la configuracion de la API:
    • En la pagina de Integraciones, haga clic en la opcion API.
  4. Obtenga o genere el token:
    • Si ya existe un token, copie la clave mostrada (ej.: ba08ab41bd58e9b9f82b4d2788b3cd9999ee9999).
    • Si no hay un token, haga clic en Generar para crear una nueva clave.
    • Copie el token generado y guardelo en un lugar seguro, ya que sera necesario para autenticar las solicitudes.

Consejo: El token es sensible y debe tratarse como una contrasena. No lo comparta publicamente ni lo exponga en repositorios de codigo.

Uso del Token en Solicitudes HTTP

Despues de obtenerlo, uselo en solicitudes HTTP con autenticacion Bearer. El token debe incluirse en el encabezado Authorization en el formato Bearer .

Configuracion de la Autenticacion Bearer

  • Encabezado HTTP:
    • Authorization: Bearer
    • Ejemplo: Authorization: Bearer ba08ab41bd58e9b9f82b4d2788b3cd9999ee9999
  • Otros encabezados:
    • accept: application/json (para recibir respuestas en JSON).
    • Content-Type: application/json (para solicitudes que envian datos, como POST o PATCH).

Ejemplo de Solicitud con cURL

Para probar la autenticacion, usaremos el endpoint de listado de cuentas (/api/v3/accounts/) como ejemplo:

curl -X GET https://eagenda.com.br/api/v3/accounts/ \
-H "accept: application/json" \
-H "Authorization: Bearer ba08ab41bd58e9b9f82b4d2788b3cd9999ee9999"

Ejemplo en Python (usando requests)

import requests

url = "https://eagenda.com.br/api/v3/accounts/"
headers = {
    "accept": "application/json",
    "Authorization": "Bearer ba08ab41bd58e9b9f82b4d2788b3cd9999ee9999"
}

response = requests.get(url, headers=headers)
print(response.status_code)
print(response.json())

Nota: Sustituya ba08ab41bd58e9b9f82b4d2788b3cd9999ee9999 por el token generado en el panel.

Verificacion de la Autenticacion

La API retornara una respuesta indicando si la autenticacion fue exitosa. Verifique los siguientes puntos:

  • Codigo de estado HTTP:
    • 200 OK: Autenticacion exitosa, y la solicitud retorno los datos solicitados.
    • 401 Unauthorized: Token invalido, ausente o expirado. Genere un nuevo token o verifique el valor informado.
    • 403 Forbidden: El token es valido, pero la cuenta no tiene permiso para acceder al recurso.
  • Cuerpo de la respuesta: Para el ejemplo de listado de cuentas, la respuesta sera similar a:[ { "slug": "minha-organizacao", "name": "Minha Saúde Ltda", "website": "https://www.minhasaude.com.br", "email": "contato@minhasaude.com.br", "phone": "+5511999999999", "url_domain": "https://agendamento.minhasaude.com.br", "time_zone": "America/Sao_Paulo", "is_active": true, "is_sub_account": false } ]

Si recibe un error 401, verifique el token en el encabezado Authorization o genere un nuevo token en el panel.

Conclusion

Con este tutorial, aprendio como autenticarse en la API de eAgenda, generar el token de acceso desde el panel y utilizarlo en solicitudes HTTP con autenticacion Bearer. Esta integracion es esencial para acceder a los endpoints de la API de forma segura y realizar operaciones como crear cuentas, citas o listar horarios. Para mas funcionalidades, consulte la documentacion completa de la API de eAgenda: https://eagenda.com.br/api/v3/documentation/#overview.

Contactenos o Sepa Mas

Estamos a su disposicion para ayudarle. Acceda a nuestros canales oficiales:

📞 WhatsApp : Haga clic aqui para enviarnos un mensaje 🌐 Plataforma eAgenda : Conozca eAgenda 🏢 Nuestra Empresa : Mupi Systems – Soluciones Innovadoras 📧 Correo electronico : contato@mupisystems.com.br 📚 Tutoriales y Documentacion : Acceda a nuestras guias y tutoriales