Administrativo – Como acessar as APIs

O SOGI disponibiliza API’s que permitem acessar informações diretamente do banco de dados, facilitando a criação de relatórios externos e integrações personalizadas.

O procedimento para utilização das API’s é simples e pode ser realizado diretamente pelo módulo administrativo do sistema.

O acesso às chaves de API e às documentações é restrito a usuários com perfil Administrador (global) ou a perfis personalizados da unidade que tenham permissão específica para essa funcionalidade.

É importante destacar que, embora as API’s estejam disponíveis, não contamos com uma equipe dedicada para apoiar na construção de integrações. Por isso, recomendamos que o time de T.I. da unidade ofereça o suporte necessário, preferencialmente alguém com familiaridade com as ferramentas e tecnologias utilizadas pela empresa.

Acessar o Módulo Administrativo

Ao fazer login no SOGI, acesse o Módulo Administrativo.

Acessar as Permissões

Acesse o menu Permissões e clique na opção Token API.

Gerar o Token API

Caso seja a primeira vez acessando essa funcionalidade, clique no botão “Gerar Token”.

Se você já possui um token ativo, não clique novamente em “Gerar Token”, pois um novo token será criado e todos os vínculos existentes serão perdidos.

 

Depois de gerar o Token, basta copiá-lo para realizar o link.

Acessando a documentação da API

Para consultar a documentação clique do link “Acessar documentação da API”

Ficará disponível no sistema a documentação de cada módulo separado

APIs disponíveis

A documentação está disponível para utilização por módulos, conforme lista abaixo:

Esse artigo foi útil?