Pular para o conteúdo
Claro
Português

Como gerar o API Token

O API Token da API de Integração REST fica no cadastro do usuário, no Demander Web. Somente um usuário com o grupo Usuário Api pode ser usado nessa integração.

Abra Usuários e entre no cadastro.

O campo ApiToken aparece quando o grupo Usuário Api está selecionado em Grupos de usuários. Sem esse grupo, o campo fica oculto.

O valor não é digitado. Use Gerar para criar um token novo. O cadeado mostra ou oculta o valor. O ícone ao lado do título copia o token.

  1. Em Usuários, crie um usuário ou abra um que já existe.
  2. No Tipo, escolha Empresa.
  3. Se o campo Empresa aparecer, preencha. Quem cadastra já sendo do tipo Empresa não vê esse campo: o usuário fica na empresa de quem está cadastrando.
  4. Em Grupos de usuários, selecione Usuário Api.
  5. Clique em Gerar no campo ApiToken.
  6. Salve.

Não é possível adicionar outros grupos de usuário quando se adiciona o grupo Usuário Api.

Ao gerar um token novo e salvar, o token anterior deixa de valer. A integração que ainda usa o token antigo para de autenticar até receber o novo.

O grupo Usuário Api só vale para o tipo Empresa. Quem cadastra já sendo do tipo Empresa não vê o campo Empresa: o usuário fica na empresa de quem está cadastrando. Nos outros cadastros, a empresa precisa estar preenchida. Fora do tipo Empresa, o cadastro não salva.

Com o grupo selecionado, o ApiToken é obrigatório. Sem token, o cadastro não salva.

Esse usuário não loga no Demander Web, no App Demander nem no App Separação. A mensagem é: “Este usuário é exclusivo da Api Rest e não acessa o Demander Web nem o aplicativo.”

O usuário precisa estar ativo. Usuário inativo não autentica na API.

Na chamada, informe a empresa do usuário e o ApiToken dele:

  • idEmpresa — código da empresa do usuário
  • x-api-token — ApiToken, no header da requisição

Exemplo na visão geral da API REST.

Não. O token é do usuário, e o usuário do grupo Usuário Api fica vinculado a uma única empresa. Um parceiro não usa o mesmo token para outras empresas.