For the complete documentation index, see llms.txt. This page is also available as Markdown.

Puntos de conexión

Primeros pasos

Primero, necesitarás Genere una clave de API.

A continuación, tu endpoint de API es uno de los siguientes:

  • https://[YOUR-TENANT-NAME].violetlabs.com/api/ para clientes de Violet

  • https://[YOUR-TENANT-NAME].violetgov.com/api/ para clientes de VioletGov

Nota: Si deseas acceder a un endpoint de API en tu entorno sandbox de Violet Staging, utiliza el https://[YOUR-TENANT-NAME].staging.violetlabs.com/api/ o https://[YOUR-TENANT-NAME].staging.violetgov.com/api/ endpoints.

Endpoints disponibles

  • Explorar – Consulta tus datos de Violet usando los mismos filtros y columnas disponibles en el Explorador de datos.

  • Entidades – Recupera un amplio conjunto de propiedades y metadatos para una o más entidades por ID, incluidas las URL de miniaturas.

  • Relaciones – Consulta relaciones entre entidades, como las líneas de pedido de compra en una orden de compra o las piezas en un ensamblaje.

  • Actividades – Consulta la actividad y el historial de cambios en todo tu tenant de Violet o para una entidad específica.

Pruébalo en Postman

Para probar en Postman:

  1. Crea una nueva solicitud en Postman, selecciona el POST método y completa tu URL (por ejemplo, https://magictoaster.violetlabs.com/api/explore/)

  2. En la pestaña Authorization, selecciona API Key en el menú desplegable Auth Type. Ingresa x-api-key como Key y completa tu clave de API como Value.

  1. En la pestaña Body, selecciona raw, luego pega la carga útil de la API que generaste para uno de los endpoints compatibles. Haz clic en Send.

  1. Tus resultados deberían aparecer abajo.

  1. Nos encanta usar el Visualizer de Postman para generar visualizaciones de tus datos:

Última actualización

¿Te fue útil?