Como autenticar na CommunityWebAPI.

A CommunityWebAPI, um serviço Restful, requer autenticação por padrão para evitar acesso não autorizado aos dados por trás do serviço. Para acessar qualquer ponto de entrada restrito, os clientes devem primeiro autenticar-se no serviço API e enviar um cabeçalho de autorização usando o processo descrito. Todos os pontos de entrada, com exceção do verificador de versão, são restritos.

Autenticando no serviço API

Para autenticar, os clientes devem fazer uma chamada POST para o método AuthenticateEx com um único parâmetro “l” (letra “L” minúscula) e um valor de (nome de usuário)|(senha). Ou seja, o nome do usuário separado por pipe da senha do usuário.
O método AuthenticateEx validará a identidade e a senha do usuário e carregará as informações do usuário se validadas. Se as credenciais passadas não forem válidas, o serviço lança uma exceção e retorna a mensagem apropriada para o cliente.
Quando bem-sucedido, o método de autenticação faz um login suave do usuário e recupera informações pertinentes para criar um token de autorização. O serviço retorna este token de autorização e atributos adicionais necessários do usuário para o cliente via um objeto JSON com os seguintes atributos.

Atributos do objeto JSON:

agentId (int) é a chave primária para a linha na tabela t_agent para o usuário especificado

userRole (int) é o id da função do usuário associado ao usuário (100 = agente, 200 = supervisor, 300 = programador, 400 = administrador, 1000 = superusuário)

userName (string) é o nome completo (Sobrenome, Nome Primeiro Nome do Meio) associado ao usuário

timeZone (int) é o fuso horário associado ao usuário; ou especificamente atribuído a esse usuário ou padronizado a partir do site / atividade empresarial atribuída

language (string) não está atualmente implementado

authToken (string) é uma string criptografada / codificada que fornece a autorização para chamadas futuras. Isso é descrito abaixo.

Invocação de método subsequente

O cliente deve reter o valor do membro authToken e fornecê-lo para chamadas subsequentes ao serviço API em um cabeçalho HTTP chamado “WFMSGAPIKEY” para qualquer ponto de entrada restrito (novamente, quase todos, então é mais seguro apenas colocá-lo em todas as chamadas, exceto AuthenticateEx). Além disso, o serviço API atualizará o token e o retornará cada vez que um cliente invocar um método restrito. Os métodos do serviço API colocarão um novo valor em um cabeçalho HTTP de resposta com o mesmo nome.

Nota a vida útil padrão de qualquer token de autorização da API é de 20 minutos.