Chaves de API

O SIP Caller permite definir Chaves de API para integrá-lo a sistemas externos. Você pode definir quantas Chaves de API precisar, atribuindo uma expiração e funções. Um sistema externo pode usar a API REST fornecida pelo SIP Caller, autenticando-se com o Token da Chave de API gerado conforme descrito abaixo.

As Chaves de API requerem o plano Enterprise.

Funções necessárias

Para criar ou editar uma Chave de API, o usuário precisa de uma das seguintes funções:

• Administrador

Para visualizar uma Chave de API, o usuário precisa de uma das seguintes funções:

• Leitor da Conta

Criar uma Chave de API

Para criar uma Chave de API:

1. Vá em "Configurações" > "Chaves de API", e depois clique em "Criar".
   
2. Especifique um nome para a Chave de API.
3. Selecione uma expiração. Observe que isso não pode ser estendido depois que a Chave de API for criada.
4. Habilite as funções que deseja conceder às aplicações que usarão esta Chave de API. Observe que isso não pode ser alterado depois que a Chave de API for criada. As funções disponíveis estão descritas em Funções da Chave de API.
5. Clique em "Salvar" para criar a Chave de API.
   
6. Uma caixa de diálogo será exibida, contendo o Token da Chave de API recém-criada. Copie o valor e guarde-o em um local seguro. Este token não será exibido novamente, e não pode ser recuperado, pois o SIP Caller não o armazenará. Se você o perder, precisará criar outra Chave de API.

Funções da Chave de API

As funções atribuídas a uma Chave de API definem o que as aplicações que a utilizam podem fazer. As funções disponíveis são as seguintes:

• Monitor de Filas da Central Telefônica: esta função é necessária para usar o módulo SIP Caller Queues Monitor e monitorar sua central telefônica em tempo real, para campanhas executadas no modo discador preditivo ou progressivo. Pode ser restrita a centrais telefônicas específicas.
• Leitor de Campanhas: esta função permite acesso somente leitura a campanhas, números de campanhas, listas negras, listas de contatos e relatórios de campanhas.
• Administrador de Campanhas: esta função permite acesso total a campanhas, números de campanhas, listas negras, listas de contatos e relatórios de campanhas.
• Administrador de Números de Campanha: esta função permite ler, adicionar e remover os números de uma campanha. Pode ser restrita a campanhas específicas.
• Provedor de Números de Campanha: esta função permite adicionar números a uma campanha, sem poder lê-los ou removê-los. Pode ser restrita a campanhas específicas.

Conceda a cada aplicação apenas as funções de que ela precisa. Por exemplo, um formulário web que envia novos leads para uma campanha precisa apenas da função Provedor de Números de Campanha, restrita a essa campanha. Consulte a documentação para desenvolvedores para mais detalhes.

Editar uma Chave de API

Para editar uma Chave de API:

1. Vá em "Configurações" > "Chaves de API", e depois clique na Chave de API que deseja editar.
   
2. Neste momento, você só pode editar o nome, e visualizar a data e hora de criação e expiração, e as funções atribuídas à Chave de API. Se precisar alterar outros valores, você precisará criar outra Chave de API.

Excluir uma Chave de API

Quando precisar revogar o acesso de uma aplicação ao SIP Caller, você precisará excluir a Chave de API. Para fazer isso:

1. Vá em "Configurações" > "Chaves de API", e depois selecione a Chave de API que deseja excluir.
2. Clique no botão Excluir e confirme a operação.