Como acessar a API do Involves Stage

O que você vai aprender:

• Como acessar a documentação da API do Involves Stage.
• Quais recursos podem ser consultados pela API.
• Onde encontrar endpoints, parâmetros e exemplos de uso.

Atalho rápido: API de integração
Versão mínima: Stage Web

Neste artigo

• O que é a API do Involves Stage
• Como acessar a documentação
• Colaboradores
• Pontos de venda
• Produtos
• Formulários
• Rotas e visitas
• Observação

O que é a API do Involves Stage

A API do Involves Stage permite realizar integrações e automações entre o sistema e outras ferramentas, facilitando a consulta, criação e atualização de informações por meio de endpoints específicos.

Os detalhes técnicos de cada endpoint, como parâmetros, formatos de requisição, exemplos de uso e respostas esperadas, estão disponíveis na documentação da API dentro do próprio sistema.

Como acessar a documentação

Para acessar a documentação da API:

1. Clique no perfil do usuário, no canto inferior esquerdo da tela;
2. Selecione a opção API de integração.

Na documentação, você encontrará a lista completa de endpoints disponíveis, além das orientações necessárias para utilizar corretamente a API do Involves Stage.

Colaboradores

Através da API, é possível realizar ações relacionadas ao cadastro e às informações dos colaboradores, como:

• Buscar dados de colaboradores;
• Atualizar informações cadastrais;
• Adicionar novos colaboradores;
• Consultar informações relacionadas a ausências;
• Registrar visitas programadas na rota de um colaborador específico.

Além dessas opções, outros endpoints relacionados a colaboradores estão disponíveis na documentação completa da API.

Pontos de venda

A API também permite consultar e gerenciar informações relacionadas aos pontos de venda, como:

• Buscar, atualizar e adicionar dados de pontos de venda;
• Consultar informações de marcas, redes e canais;
• Buscar regionais vinculadas aos pontos de venda;
• Consultar países e cidades relacionados aos pontos de venda.

Para conhecer todos os endpoints disponíveis para esse recurso, consulte a documentação da API dentro do sistema.

Produtos

Nos recursos relacionados a produtos, a API permite trabalhar com informações como SKUs, linhas de produto, categorias, supercategorias e marcas.

Algumas possibilidades incluem:

• Buscar, atualizar e adicionar SKUs;
• Buscar, atualizar e adicionar linhas de produto;
• Consultar categorias e supercategorias;
• Buscar marcas;
• Consultar IDs relacionados a SKUs, linhas de produto, categorias e marcas.

Esses dados podem ser úteis em integrações que precisem criar, consultar ou atualizar informações de produto automaticamente.

Formulários

A API também oferece endpoints relacionados a formulários.

Com eles, é possível consultar informações como:

• IDs de formulários;
• Formulários ativos;
• Campos vinculados aos formulários.

Essas informações podem ajudar integrações que precisem identificar formulários e seus respectivos campos para consultas ou automações.

Rotas e visitas

Para rotas e visitas, a API permite consultar e registrar informações de visitas programadas.

Algumas possibilidades incluem:

• Buscar visitas programadas para uma data específica;
• Consultar visitas de um colaborador;
• Registrar visitas programadas para um colaborador.

Esses endpoints podem ser utilizados em integrações que precisem automatizar ou consultar a agenda de visitas dos colaboradores.

Observação

Os exemplos apresentados acima representam apenas algumas possibilidades de uso da API do Involves Stage.

Para verificar todos os endpoints disponíveis, entender os parâmetros obrigatórios, formatos de envio, regras de autenticação e exemplos de resposta, acesse a documentação completa da API dentro do sistema, através da opção API de integração no perfil do usuário.