Inicio/Artículo
Esadax JournalPlatform

Referencia de CLI y API

📘 Recursos generales de API Bienvenido a la referencia de la API de Esadax. Aquí encontrará toda la información esencial que necesita para interactuar con nuestra API, incluida la forma de autenticarse, comprender

📘 Recursos generales de API

Bienvenido a la referencia de la API de Esadax. Aquí encontrará toda la información esencial que necesita para interactuar con nuestra API, incluida la forma de autenticarse, comprender los estados de respuesta y resolver errores de validación.


Autenticación

Todas las solicitudes de API deben autenticarse mediante un token de API. Esto se hace agregando un encabezado Authorization a su solicitud HTTP.

✅ Formato de encabezado

Authorization: Bearer XXX

Reemplaza XXX por tu token API real.

Acerca de los tokens API

  • Los tokens de API se generan por cuenta de usuario.
  • Cada token puede tener permisos personalizados para limitar el acceso a áreas específicas de su cuenta.
  • Esto ayuda a mantener su integración segura al conceder solo el acceso que sea necesario.

➡️ Leer más sobre la gestión de tokens API


Respuestas de API

Esadax utiliza principios RESTful y se ajusta a las prácticas estándar de respuesta HTTP. Cada respuesta de la API incluirá un código de estado HTTP relevante para indicar el éxito o el fracaso de su solicitud.


📊 Códigos de estado HTTP

Código Nombre Descripción
200 dólares OK La solicitud fue aceptada con éxito.
201 Creado El recurso se creó correctamente.
202 Recomendación aceptada La solicitud fue aceptada y el procesamiento continúa en segundo plano.
204 No hay contenido La solicitud fue aceptada, pero no hay contenido para devolver.
400 dólares Una mala petición Se ha producido un error con su solicitud. Compruebe los requisitos del punto final e inténtelo de nuevo.
401 No autorizado Token de API no válido. Leer más.
403 Prohibido La acción no está permitida para este token o cuenta. Compruebe los permisos de token.
404 Archivo no encontrado La página solicitada no existe.
405 Método no permitido El método HTTP utilizado no es compatible con este extremo.
408 Tiempo de espera de solicitud Hubo un tiempo muerto en nuestro extremo. Póngase en contacto con el soporte.
421 Servicio no disponible Estamos realizando tareas de mantenimiento. Vuelve a intentarlo más tarde.
422 Entidad no procesable Error de validación en su solicitud. Revise y vuelva a intentarlo. Leer más
429 Demasiadas solicitudes Límite de tasa excedido. Lea más sobre los límites de velocidad
500 dólares Error interno del servidor Error de servidor inesperado. Póngase en contacto con el soporte.
502 Puerta de enlace incorrecta Problema temporal del sistema. Póngase en contacto con el soporte.
503 Servicio no disponible El sistema no está disponible actualmente. Póngase en contacto con el soporte.
504 Tiempo de espera de puerta de enlace Hubo un tiempo de espera en nuestro sistema. Póngase en contacto con el soporte.

🔗 Puedes encontrar más información sobre los códigos de estado HTTP en Mozilla Developer Network.


Errores de validación

Los errores de validación (HTTP 422) se producen cuando la carga útil de la solicitud no cumple los requisitos de un extremo determinado. Esto puede deberse a:

  • Faltan campos obligatorios
  • Formatos de datos no válidos
  • Parámetros incorrectos

Revisa siempre la documentación del punto final de la API para asegurarte de que el cuerpo de la solicitud coincida con el formato esperado.


Suscribirse