A NuVidio oferece para a empresa toda a integração necessária para gerenciar a sua conta totalmente via API, sem a necessidade de acesso ao portal de gerenciamento.

Esse formato de integração possibilita uma integração transparente e com menor atrito, possibilitando o gerenciamento de seus atendentes e departamentos dentro do próprio fluxo da empresa.

Para utilização da Open API é necessário a criação da credencial de acesso dentro do próprio Portal da Empresa gerando uma API Key e um API Secret que serão utilizados para autenticar o acesso.

🔑 Como criar a chave de API?

Para criação de uma nova chave basta acessar Portal da Empresa > Configurações > Desenvolvedores:

Após entrar na tela, selecione “Criar nova chave de acesso”.

⚠️

É importante saber que essa chave é única e caso precise ser gerada novamente a chave anterior perderá o seu valor. O secret é exibido somente uma vez, por isso, deve ser armazenado de maneira segura e não deve ser compartilhado.

🔑 Token de Autenticação

Após a criação das novas chaves, é possível criar o token para autenticação com uma expiração de 10 minutos, com esse token dentro do período de validade suas requisições estarão autenticadas e você poderá consumir os seus dados via Open API da Nuvidio.

Para a criação do token, utilizando uma ferramenta que permite testar e gerenciar APIs, com o método POST e o seguinte endpoint: https://api.nuvidio.com/v1/api/auth e informando a apiKey e apiSecret no body. Conforme print:

📦 Corpo da Requisição:

{
"apiKey": "{{API_KEY}}",
"apiSecret": "{{API_SECRET}}"
}

🔎 Parâmetros da Requisição:

✅ Exemplo de Resposta:

{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjY3YzlkN2NlOWNlOTZmMmYyOTMwMWFmNiIsImlhdCI6MTc0MzUyMTk3MywiZXhwIjoxNzQzNTI1NTczfQ.W-JBnM4vxnYmojIL6yTIlhSoB-zrZCxON-ux6zFnYRY",
  "tokenExpiration": "2025-04-01T16:39:33.487Z"
}

⚠️

O token gerado terá duração de 10 minutos e após expiração deverá ser gerado novamente para utilização de nossa API.

❌ Respostas de erro:

🔒Enviar Access Token nas requisições para Open API Nuvidio:

Com o token em mãos basta enviá-lo em todas as requisições que você realizar nos próximos 10 minutos através do header authorization. O formato de envio deve ser o seguinte:

"headers": {
...
"authorization": "Bearer {{TOKEN}}"
...
}

Exemplo:

"headers": {
...
"authorization": "Bearer eyJhASOIPnsn998919IsInR5cCI6IkpXVCJ9.eyJpZCI6IjVmNOJSANNojan72179dn198&8Nu7McabnioB97BDcxNjk1OCwiZXhwIjoxNjk4NzE3NTU4fQ.hequWhG5OTvqOUsb18bsC9Ca0Nu81PanA95wnYk6HtG9zU"
...
}

🔐Autenticação com Bearer Token

A Nuvidio ainda oferece a possibilidade de realizar a autenticação via Bearer Token.

Você também pode selecionar o Authorization, utilizando o formato Bearer Token, conforme print abaixo:

📙 Autenticação com Basic Authentication:

A Nuvidio ainda oferece a possibilidade de realizar a autenticação via Basic Authentication.

Basicamente deve ser enviado um header de authorization onde o valor segue o seguinte padrão: Basic apikey:apisecret. É preciso se atentar ao fato que a apikey:apisecret deve estar no formato de base64.

📗 Conversão para base64:

O código abaixo apresenta uma breve implementação de encode e decode de uma string para base64. É importante salientar que a internet disponibiliza diversas maneiras de se realizar esse procedimento, então sinta-se confortável em testar outras implementações.

NodeJs

exportconst encodeBase64 = (value: string) => {
return Buffer.from(data).toString('base64');
};

exportconst decodeBase64 = (value: string) => {
return Buffer.from(data, 'base64').toString('ascii');
};

Javascript Web

export const encodeBase64 = (value: string) => {
  return window.btoa(value);
};

export const decodeBase64 = (value: string) => {
  return window.atob(value);
};

💡

Sugestão de site para conversão em base64: 👉 aqui