Autenticação
Obtenção e uso da chave de acesso da API Consultiva e identificação da loja consultada.
Toda requisição à API Consultiva exige duas informações:
| Informação | Finalidade | Onde é enviada |
|---|---|---|
| Chave de acesso (token) | identificar o usuário que realiza a consulta | cabeçalho HTTP Authorization |
Loja (empresa ou cnpj) | indicar de qual loja são os dados | parâmetro da requisição |
Chave de acesso
A chave de acesso fica disponível no cadastro do usuário, no ssOtica, e é exibida ao abrir o
usuário para edição. Ela deve ser enviada em todas as requisições, no cabeçalho Authorization:
Authorization: Bearer XXXyyyXXXyXXXXXXXXXXyXXXyXXXyXXXA chave é exibida somente para usuários administradores com acesso à loja contratante, e a loja precisa ter a API contratada.
Não utilize o login para obter a chave
A rota POST /api/v1/login gera uma nova chave a cada chamada e invalida a anterior. Caso a
integração utilize essa rota, a chave copiada do cadastro deixa de funcionar, inclusive em outras
integrações vinculadas ao mesmo usuário. Utilize sempre a chave disponível no cadastro.
Identificação da loja
A loja consultada é informada por um dos parâmetros abaixo:
empresa: o Código da Licença, enviado por e-mail na contratação e exibido no sistema com esse mesmo nome;cnpj: o CNPJ da loja, com ou sem máscara.
A consulta é restrita às lojas da rede do usuário vinculado à chave.
curl -G https://app.ssotica.com.br/api/v1/integracoes/clientes \
-H "Authorization: Bearer {sua_chave}" \
--data-urlencode "empresa=XXXX-XXXX"Erros de acesso
| Resposta | Situação | Como proceder |
|---|---|---|
401 com o texto Unauthorized. | chave ausente ou inválida | verificar a chave no cadastro do usuário (ela é substituída sempre que o login é utilizado) |
401 com mensagem em texto | usuário bloqueado ou sem loja ativa | contatar o administrador do sistema |
400 com EMPRESA_NAO_ENCONTRADA | empresa ou cnpj não localizados na rede | verificar o Código da Licença ou o CNPJ |
400 com API_NAO_CONTRATADA | a loja não possui a API em contrato | solicitar a contratação pelo chat de atendimento |
400 com CONTRATO_ILEGIVEL | falha temporária na verificação do contrato | repetir a requisição após alguns instantes |
Os erros 400 seguem o formato { "error": "CODIGO", "error_info": "mensagem" }. A lista completa
está em Conceitos.