Detalhes técnicos da API de Audit

A API de Audit da Vonage permite que você monitore sua conta por meio do acompanhamento de eventos. Esses eventos são gerados quando os usuários da sua conta utilizam os SDKs ou interagem com o Painel da API da Vonage.

Com essa API, você pode:

Recuperar uma lista de eventos de Audit.
Recuperar um evento de Audit específico.
Filtre eventos por parâmetros como data, ID do usuário e tipo de evento.

Beta

Atualmente, essa API está em fase beta.

A Vonage sempre agradece seus comentários. Suas sugestões nos ajudam a melhorar o produto. Caso precise de ajuda, envie um e-mail para apoio e inclua “API de Audit” na linha de assunto. Observe que, durante o período beta, o horário de atendimento é limitado de segunda a sexta-feira.

Durante o período de beta, a Vonage poderá ampliar os recursos da API de Audit.

Índice

Neste documento, você poderá conhecer:

Autenticação
Eventos de Audit
Objeto de evento de Audit
Como começar a usar a API de auditoria
Concepts
Trechos de código
Casos de uso
Referência

Autenticação

As interações com a API de Audit são autenticadas por meio da Autenticação Básica. A Autenticação Básica permite que você use seu VONAGE_API_KEY e VONAGE_API_SECRET para validar suas solicitações de API. Para obter informações mais gerais sobre autenticação, consulte Autenticação.

Eventos de Audit

Eventos de auditagem são atividades que ocorrem quando um usuário interage com a API da Vonage ou com o Painel da API da Vonage. Os eventos de auditagem são representados por um objeto JSON. Exemplos de eventos de auditagem incluem:

Atualizações nas configurações da Account.
Um número da Vonage é atribuído a um aplicativo.
Criação de uma aplicação da Vonage.

Mais informações sobre os tipos de eventos de auditagem estão disponíveis no Eventos de Audit página.

Objeto Evento de Audit

Um exemplo de objeto de evento de auditoria é “atualização de um número”, que possui event_type de NUMBER_UPDATED:

{
  "_links": {
    "self": {
      "href": "http://api.nexmo.com/beta/audit/events/aaaaaaaa-bbbb-cccc-dddd-0123456789ab"
    }
  },
  "id": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
  "event_type": "NUMBER_UPDATED",
  "event_type_description": "Number updated",
  "created_at": "2018-08-13T10:15:31",
  "account_id": "abcd1234",
  "source": "DEVAPI",
  "source_ip": "154.59.142.233",
  "source_description": "Developer API",
  "source_country": "GB",
  "context": {
    "country": "GB",
    "msisdn": "447700900000",
    "voice-type": "sip",
    "voice-value": "sip:user@example12.com",
    "accountId": "abcd1234"
  }
}

Introdução

Este exemplo mostra como começar a usar a API de Audit. Ele demonstra como recuperar uma lista de eventos de Audit.

Você precisará garantir que os seguintes valores substituíveis sejam definidos no código de exemplo, utilizando qualquer método que lhe seja conveniente:

Chave	Descrição
`VONAGE_API_KEY`	Sua chave de API da Vonage.
`VONAGE_API_SECRET`	Seu segredo da API da Vonage.

No exemplo a seguir, o Criar um aplicativo e Inicialize suas dependências Os procedimentos são opcionais.

Pré-requisitos

Um aplicativo da Vonage contém a configuração necessária para o seu projeto. Você pode criar um aplicativo usando o CLI da Vonage (veja abaixo) ou pelo painel de controle. Para saber mais sobre os aplicativos, acesse consulte nosso guia de conceitos da Vonage.

Instale a CLI

npm install -g nexmo-cli

Criar um aplicativo

Depois de instalar a CLI, você poderá usá-la para criar um aplicativo Vonage. Execute o comando a seguir e anote o ID do aplicativo que for retornado. Esse é o valor que deve ser usado em NEXMO_APPLICATION_ID no exemplo abaixo. Isso também criará o arquivo private.key no diretório atual, que você precisará na etapa Inicialize suas dependências

O Vonage precisa se conectar ao seu computador local para acessar o answer_url. Recomendamos usar o ngrok para fazer isso. Certifique-se de substituir demo.ngrok.io nos exemplos abaixo pelo seu próprio URL do ngrok.

nexmo app:create "Get Audit Events" http://demo.ngrok.io/webhooks/answer http://demo.ngrok.io/webhooks/events --keyfile private.key

Crie um arquivo chamado ` get-events.sh ` e insira o seguinte código:

source "../config.sh"

Ver código-fonte completo

Escreva o código

Adicione o seguinte ao arquivo ` get-events.sh`:

curl "https://api.nexmo.com/beta/audit/events" \
     -u "$VONAGE_API_KEY:$VONAGE_API_SECRET"

Ver código-fonte completo

Execute seu código

Salve este arquivo no seu computador e execute-o:

./get-events.sh

Pré-requisitos

Instale a CLI

npm install -g nexmo-cli

Criar um aplicativo

nexmo app:create "Get Audit Events" http://demo.ngrok.io/webhooks/answer http://demo.ngrok.io/webhooks/events --keyfile private.key

npm install @vonage/audit

Crie um arquivo chamado ` get-events.js ` e insira o seguinte código:

const { Audit } = require('@vonage/audit');

const auditClient = new Audit({
  apiKey: VONAGE_API_KEY,
  apiSecret: VONAGE_API_SECRET,
});

Ver código-fonte completo

Escreva o código

Adicione o seguinte ao arquivo ` get-events.js`:

const run = async () => {
  try {
    for await (const event of auditClient.getEvents()) {
      console.log(event);
    }
  } catch (error) {
    console.log(error);
  }
};
run();