Portal da API

Consistem API

O Consistem ERP fornece uma interface interativa baseada em Swagger, permitindo a visualização dos endpoints disponíveis e a execução de testes de requisições em tempo real diretamente no seu ambiente. Para acessar o Portal da API, utilize o endereço do seu ambiente seguido de /api/:

https://URL_ACESSO_ERP/api/

Como Testar as APIs

Você pode testar as integrações diretamente através da interface do Swagger instalada no seu servidor do Consistem ERP.

Portal da API

Obtenção da chave de acesso (Token)

Utilize a chave gerada através do Cadastro de Usuário (CSMEN050). Para instruções detalhadas de geração, acesse a documentação de Chave de acesso.

Autenticação no Portal

Antes de realizar qualquer teste, é necessário autenticar sua sessão:

1. Clique no botão Authorize (cadeado).
2. No campo Value, informe o token gerado anteriormente.
3. Clique novamente em Authorize e, em seguida, em Close.

Executando uma Requisição

Com a sessão autenticada, você pode simular chamadas reais:

1. Selecione o grupo e o serviço desejado (Ex: Cadastros Gerais -> GET /empresa/id).
2. Clique no botão Try it out para habilitar a edição.
3. Preencha os parâmetros solicitados (campos marcados com * são obrigatórios).
4. Clique no botão Execute.

Analisando a Resposta

Logo abaixo, a interface exibirá o Response body (dados retornados) e o Code (status da resposta, ex: 200, 404, 500).

Nota As APIs seguem padrões de mercado e podem ser executadas em qualquer ferramenta externa de sua preferência, como o Postman ou Insomnia.

Esse conteúdo foi útil?

Sim Não