¿Cómo obtener una API Key
Se requiere una API Key para interactuar con la API, la cual se puede obtener de dos maneras:
-
Cada vez que se instala una aplicación, Zenvia Conversion generará automáticamente una nueva API Key para ella.
-
Para otros usos únicos, puedes generar manualmente una API Key utilizando la API Access App.
¿Cómo crear tu App Manifest
El primer paso para desarrollar tu aplicación es definir un manifiesto de aplicación. Este documento declara los puntos de extensión que utiliza la aplicación y otros detalles necesarios (por ejemplo, dónde se aloja el backend de la aplicación). Para comenzar a desarrollar tu App y definir un App Manifest, completa el siguiente formulario: https://forms.gle/SB6CtR8qwHou6GJm8
¿Cómo hacer pública tu aplicación
Si deseas publicar tu aplicación en App Marketplace, complete el siguiente formulario: https://forms.gle/bjxbhBPeo3PtHeFA7
¿Cómo importar puntos finales de API a Postman
Para tener todos los puntos finales de la API en Postman, debes descargar el archivo Swagger de la Referencia e importarlo desde Postman. Tendrás automáticamente todos los puntos finales y los parámetros de consulta.
¿Cómo suscribirse a Webhooks
Para suscribirse a Webhooks, haz clic en tu aplicación API Access en la sección de Apps de Zenvia Conversion y asegúrese de que Webhooks esté marcado en Nivel de acceso:
Una vez que habilites los webhooks, envíe una solicitud POST a la siguiente URL:
En el cuerpo de la solicitud, envíe el siguiente JSON:
{
"topics":[
"string" // can be "interactions", "prospects", "quotes","agents"
],
"callbackUrl": "string" // This is the URL that will be listening
}
¡Eso es todo! Comenzarás a recibir una notificación en la URL de devolución de llamada según los temas a los que se suscribió.