Como conseguir uma API Key

Uma API Key é necessária para interagir com a API, e pode ser obtida de duas maneiras:

  • Cada vez que um aplicativo é instalado, a Zenvia Conversion gerará automáticamente uma nova API Key para ele.

  • Para outros usos pontuais, você pode gerar manualmente uma API Key usando a API Acess App.

Como criar seu App Manifest

O primeiro passo para desenvolver seu App é definir um App Manifest. Este documento declara os pontos de extensão que o aplicativo usa e outros detalhes necessários (por exemplo, onde o back-end do aplicativo está hospedado).

Para começar a desenvolver seu App e definir um App Manifest, preencha o seguinte formulário: https://forms.gle/SB6CtR8qwHou6GJm8

Como tornar seu aplicativo público

Se você deseja publicar seu aplicativo no App Marketplace, preencha o seguinte formulário: https://forms.gle/bjxbhBPeo3PtHeFA7

Como importar endpoints da API para postman

Para ter todos os endpoints da API no postman, você precisa baixar o arquivo Swagger da Referência e importá-lo do Postman. Você terá automaticamente todos os endpoints e os parâmetros de consulta.

Como assinar Webhooks

Para se inscrever em Webhooks, clique no aplicativo de acesso à API na seção de Apps na Zenvia Conversion e verifique se Webhooks está marcado em Nível de acesso:

Depois de habilitar os Webhooks, envie uma solicitação POST para a seguinte URL:

https://api.getsirena.com/v1/notifications/subscriptions?api-key=YOUR_API_KEY

No corpo da solicitação, envie o seguinte JSON:

{
"topics":[
"string" // can be "interactions", "prospects", "quotes","agents"
],
"callbackUrl": "string" // This is the URL that will be listening
}

E isso é tudo! Você já começará a receber notificações na URL de retorno de chamada com base nos tópicos que se inscreveu.


Artigos relacionados:

Encontrou a sua resposta?