En este artículo encontrarás ejemplos prácticos de cómo consumir los diferentes tipos de endpoints disponibles en la API de Adm Cloud.
Cada tipo de endpoint cumple una función específica dentro de la integración, por lo que es importante entender cuándo y cómo utilizar cada uno.
En el siguiente artículo puedes conocer todos los detalles sobre cómo realizar una Integración con Web Services en Adm Cloud.
Índice
Consumo de un endpoint GET
Ejemplo de consumo de un endpoint GET
Consumo de un endpoint POST
Ejemplo de consumo de un endpoint POST
Consumo de un endpoint PUT
Ejemplo de consumo de un endpoint PUT
Consumo de un endpoint DELETE
Ejemplo de consumo de un endpoint DELETE
Consumo de un endpoint GET
Un endpoint GET 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 en Adm Cloud API
A continuación, puedes observar un ejemplo de consumo de un endpoint GET:
Luego de acceder al endpoint:
- Completa los siguientes datos:
🔹skip
🔹Logueo: puede ser básico (company, role y appid) o por token - Presiona el botón Try it out!
- Verifica que el estatus sea 200
- Consulta el campo Response Body para ver el resultado
Consumo de un endpoint POST
Un endpoint POST 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
Ejemplo en Adm Cloud API
A continuación, puedes ver un ejemplo de consumo de un endpoint POST:
Luego de acceder al endpoint:
- Completa los siguientes datos:
🔹Record (en formato JSON, tomando como referencia el campo Example Value)
🔹Logueo: puede ser básico (company, role y appid) o por token - Presiona el botón Try it out!
- Verifica que el estatus sea 200
- Consulta el campo Response Body para ver el resultado
Consumo de un endpoint PUT
Un endpoint PUT permite actualizar completamente un registro existente en la API.
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
Ejemplo en Adm Cloud API
A continuación, puedes ver un ejemplo de consumo de un endpoint PUT:
Luego de acceder al endpoint:
- Completa los siguientes datos:
🔹Record (en formato JSON, tomando como referencia el campo Example Value)
🔹Logueo: puede ser básico (company, role y appid) o por token - Presiona el botón Try it out!
- Verifica que el estatus sea 200
- Consulta el campo Response Body para ver el resultado
Consumo de un endpoint DELETE
Un endpoint DELETE permite eliminar un registro existente en la API.
A diferencia de GET o POST, este tipo de endpoint elimina información 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
Ejemplo en Adm Cloud API
A continuación, puedes ver un ejemplo de consumo de un endpoint DELETE:
Luego de acceder al endpoint:
- Completa los siguientes datos:
🔹Id (Guid del registro que deseas eliminar)
🔹Logueo: puede ser básico (company, role y appid) o por token - Presiona el botón Try it out!
- Verifica que el estatus sea 200
- Consulta el campo Response Body para ver el resultado