Tipos de operaciones y manejo de errores

Conoce los distintos tipos de endpoints disponibles en el API de Adm Cloud y cómo interpretar sus respuestas.

Cada endpoint del API de Adm Cloud responde a un método HTTP distinto, según el tipo de operación que realiza.

MétodoUso
GETObtener información
POSTCrear registros
PUTActualizar información
DELETEEliminar registros

📥 GET — Consultar información

Permite consultar información desde la API sin modificar los datos.

Se utiliza para:

  • Obtener listados (clientes, artículos, ventas, etc.)
  • Consultar registros específicos
  • Filtrar información

Ejemplo:

GET https://api.admcloud.net/api/Customers?skip=0&token=...


📤 POST — Crear registros

Permite enviar información a la API para crear nuevos registros. A diferencia de GET, este tipo de endpoint sí modifica los datos en el sistema.

Se utiliza para:

- Crear registros (clientes, artículos, pedidos, etc.)
- Enviar información desde formularios
- Registrar datos en el sistema

Requiere enviar un Record en formato JSON en el cuerpo de la solicitud, siguiendo la estructura del endpoint (puedes ver un ejemplo del formato esperado en el API Reference).

Ejemplo:

POST https://api.admcloud.net/api/Customers?token=...

{
  "Nombre": "Cliente Nuevo",
  "RNC": "123456789"
}

✏️ PUT — Actualizar registros

Permite actualizar completamente un registro existente. A diferencia de POST, este tipo de endpoint reemplaza toda la información del registro.

Se utiliza para:

  • Actualizar registros (clientes, artículos, pedidos, etc.)
  • Reemplazar toda la información de un registro
  • Mantener datos actualizados en el sistema

Igual que en POST, requiere enviar un Record en formato JSON con la información completa del registro.

Ejemplo:

PUT https://api.admcloud.net/api/Customers?token=...


🗑️ DELETE — Eliminar registros

Permite eliminar un registro existente del sistema.

Se utiliza para:

- Eliminar registros (clientes, artículos, pedidos, etc.)
- Borrar información específica por identificador
- Mantener la base de datos actualizada

Requiere el Id (Guid) del registro que deseas eliminar.

Ejemplo:

DELETE https://api.admcloud.net/api/Customers/{id}?token=...

⚠️ Códigos de estado HTTP

CódigoSignificado
✅ 200 – OKLa solicitud fue exitosa
🆕 201 – CreatedEl recurso fue creado correctamente
⚠️ 400 – Bad RequestLa solicitud está mal formada (datos incorrectos o incompletos)
🔐 401 – UnauthorizedNo tienes permisos o falta autenticación
🚫 403 – ForbiddenTienes credenciales, pero no acceso a ese recurso
🔍 404 – Not FoundEl recurso no existe
💥 500 – Internal Server ErrorError en el servidor

🛠️ Buenas prácticas para el manejo de errores

  1. Verifica siempre el código de estado HTTP de la respuesta.
  2. Revisa el mensaje de error para entender la causa del problema.
  3. Valida la información antes de enviar la solicitud.
  4. Implementa manejo de errores en tu integración, asegurándote de:
    • Revisar las credenciales utilizadas (token o usuario/contraseña)
    • Verificar que el endpoint y el método (GET, POST, PUT, DELETE) sean correctos
    • Confirmar que los datos enviados tengan el formato esperado
    • Validar permisos y accesos configurados

Puedes ver el detalle completo de parámetros y estructura de cada endpoint en el API Reference.



Did this page help you?