Autenticação

Antes de iniciar a integração, o integrador deve obter uma chave de licença junto à Nice. Essa chave será utilizada para ativar o SDK e obter acesso às funcionalidades. A chave de ativação será gerada para o computador onde a API está instalada e deverá ser utilizada nas requisições dos demais serviços da API.

Endpoint de Ativação

Após obter a chave de licença, o integrador deve utilizá-la no seguinte endpoint para gerar uma chave de ativação:

UseLicense

Método: POST

Endpoint: /api/v1/useLicenses/activations

Gerar Chave de Ativação com a licença de uso

post

Autorizações

BearerApiKey

AuthorizationstringObrigatório

JWT Authorization header using the Bearer scheme.

Enter 'Bearer'[space] and then your token in the text input below.

Example: "Bearer 12345abcdef"

Parâmetros de consulta

cultureNamestringOpcional

Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)

Default: en-US

Corpo

application/jsontext/jsonapplication/*+json

useLicenseKeystring | nuloOpcional

Respostas

201

Quando ocorrer com sucesso

application/json

400

Quando ocorrer erro

application/json

post

/api/v1/useLicenses/activations

HTTPcURLJavaScriptPython

POST /api/v1/useLicenses/activations HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 24

{
  "useLicenseKey": "text"
}

application/jsontext/jsonapplication/*+json

{
  "success": true,
  "failure": true,
  "data": {
    "integratorId": 1,
    "useLicenseKey": "text",
    "ipAddress": "text",
    "hardwareId": "text",
    "createdAt": "2026-01-16T14:20:10.752Z",
    "activationKey": "text",
    "localGenerate": true
  }
}

Descrição: Gera a chave de ativação com a licença de uso.

Parâmetros

Nome	Localização	Tipo	Obrigatório	Descrição
localGenerate	query	boolean	Sim	Define o método de geração da chave. Valores possíveis: true para geração local e false para geração integrada. (Padrão: false)

Corpo da Requisição

O corpo da requisição deve conter a chave de licença, conforme o modelo abaixo:

{
  "useLicenseKey": "string"
}

Respostas

Código	Descrição
201	Chave de ativação gerada com sucesso.
400	Requisição inválida.

Em caso de erro 400, a resposta retornará detalhes sobre o problema encontrado.

Funcionamento

Ao enviar a requisição com a chave de licença válida, o integrador obterá uma chave de ativação, permitindo acesso total ao SDK e suas funcionalidades.

Guarde essa chave em um lugar seguro para consultas posteriores!

Caso haja alguma dúvida sobre o processo de ativação, entre em contato com o suporte da Nice.