Autorização de API - Configuração de Usuários

Visão Geral

A partir da versão 4.35 do sistema, foi introduzida uma funcionalidade que permite controlar quais usuários podem acessar as APIs da plataforma. Esse recurso traz mais segurança para integrações, permitindo um nível de controle mais rigoroso sobre o consumo de serviços por usuários de integração.

Atenção: Clientes recentes da implantação já vêm com essa configuração aplicada. Porém, clientes que já estão na carteira podem se deparar com erros de autorização de API relacionados a essa funcionalidade, sendo necessário aplicar a configuração descrita neste artigo.

Criação de Usuários

Para clientes que utilizam autorização de API, é necessário criar dois usuários VIDYA:

Importante: Manter o padrão de nomenclatura — sempre criar o usuário como VIDYA, mantendo esse mesmo nome para o usuário de integração (VIDYA.API).

Usuário de Integração (VIDYA.API)

- Utilizado para integrar com a API e realizar as requisições.

- Para configurar: na tela de usuários, em *Tipo de Usuário, selecionar **Integração*.

OBS: Esse usuário é exclusivo para integração, por isso não visualiza as telas do Sankhya. Ainda assim, é importante liberar o acesso às telas para esse usuário.

Usuário de Interface (VIDYA)

- Utilizado para acessar o Sankhya e realizar configurações.

- Visualiza as telas normalmente.

- Para configurar: na tela de usuários, em Tipo de Usuário, selecionar Interface.

Como Identificar o Serviço a Ser Liberado

Em termos técnicos, é possível identificar qual serviço precisa ser liberado usando o Inspecionar do navegador ou através de requisições no Postman.

Obs. 1: Em muitos casos, o cabeçalho do pedido retorna apenas erro 500. Porém, o cabeçalho geralmente precisa de diversas liberações do CRUDServiceProvider — especificamente loadRecords e saveRecords. Esse é um bom ponto de partida para análise quando o erro estiver relacionado ao cabeçalho do pedido.

Obs. 2: Uma das formas de descobrir qual serviço precisa ser liberado é usar o Force Web em conjunto com o *Inspecionar* do navegador.

Referência Oficial

A Sankhya disponibiliza um artigo com mais detalhes sobre a tela de Autorização de API e as mensagens de retorno:

🔗 [Como controlar o acesso de usuários às APIs utilizando a tela Autorização de API](https://ajuda.sankhya.com.br/hc/pt-br/articles/34162979696663-Como-controlar-o-acesso-de-usu%C3%A1rios-%C3%A0s-APIs-utilizando-a-tela-Autoriza%C3%A7%C3%A3o-de-API)

Exemplos de Autorizações Necessárias

ImpressaoNotasSP.getDocument 

Permite: Gerar nota fiscal 

ConfiguradorLayoutNotaSP.getMetadadosCentralNota 

Permite: Cabeçalho do pedido (layout da nota) |

Passo a Passo

Acesse a tela autorização de API

Consulte a API a ser liberada

Inclua o usuário Vidya

Obs: O usuário Vidya que irá aparecer para incluir sempre vai ser o que tem o Tipo: Integração