Visão Geral

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.

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 são as seguintes:
   • Phone System Queues Monitor: esta função é necessária para usar o módulo SIP Caller Queues Monitor e monitorar seu sistema telefônico em tempo real.
   • Campaign Reader: esta função permite ler campanhas e números de campanhas.
   • Campaign Admin: esta função permite duplicar campanhas, alterar o estado de uma campanha, e excluir campanhas.
   • Campaign Number Admin: esta função permite adicionar e remover números de uma campanha.
   • Campaign Number Provider: esta função permite adicionar números a uma campanha.
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.

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.