Desenvolvedores

Integre seu sistema ao GransoftWeb com a ajuda de uma IA

A API do GransoftWeb permite consultar estoque e clientes, criar orçamentos, agendar visitas e muito mais. Você não precisa ser especialista: entregue a nossa documentação a uma IA, como ChatGPT, Claude ou Copilot, e peça a integração de que precisa.

Como começar Guia de início rápido

Documentação, kit em Node.js e servidor MCP de documentação gratuitos para clientes GransoftWeb.

Passo a passo

Da ideia à integração em três passos

  1. Crie um usuário para a integração no GransoftWeb, com as permissões de que ela precisa. Entre com ele em server1.gransoftweb.com/API e copie a chave de teste (userHash) e a URL base.
  2. Entregue a documentação à IA. Cole na conversa o pedido ao lado, com o link do nosso índice para IAs. Em editores como Cursor, VS Code ou Claude Code, conecte também o MCP de documentação.
  3. Peça o que você quer, com detalhes: o que a aplicação deve fazer e onde o resultado vai aparecer. Teste com o usuário de integração e confira o resultado no GransoftWeb.
Nunca cole o seu userHash na conversa com a IA. Ele dá acesso ao sistema como uma senha. Diga à IA que ele está na variável de ambiente GRANSOFT_USERHASH.

Pedido para colar na IA

Vou integrar meu sistema com a API do GransoftWeb.
Antes de escrever código, leia a documentação oficial:
https://www.gransoftweb.com/developers/llms.txt

Siga os guias e use o kit em Node.js (gransoft-client.js).
Não invente métodos nem campos: se algo não estiver
na documentação, me pergunte.

Quero: um script que liste as chapas disponíveis de um
material, com medidas e total em m².

Troque a última linha pelo que você precisa. Se a IA não abrir links, baixe llms-full.txt (toda a documentação em um arquivo) e anexe-o à conversa.

Recursos

Tudo o que a IA precisa para acertar na primeira vez

Guias conferidos no código do sistema, com exemplos de requisição e resposta, regras de erro e de limite de uso.

Kit em Node.js

Cliente pronto que já cuida da autenticação, dos erros e do limite de requisições, com exemplos de estoque, clientes e orçamento. A IA usa como base também para outras linguagens.

MCP de documentação

Servidor MCP público e só de leitura: a IA busca nos guias e no Swagger apenas o trecho de que precisa, sempre na versão atual. Não acessa dados de nenhuma empresa.

Como conectar

Claude Code

claude mcp add --transport http gransoft-docs https://www.gransoftweb.com/developers/mcp

Cursor (.cursor/mcp.json)

{ "mcpServers": { "gransoft-docs": { "url": "https://www.gransoftweb.com/developers/mcp" } } }

VS Code (.vscode/mcp.json)

{ "servers": { "gransoft-docs": { "type": "http", "url": "https://www.gransoftweb.com/developers/mcp" } } }

MCP de documentação

Conecte a documentação ao seu editor com IA

O MCP (Model Context Protocol) é a forma padrão de dar ferramentas a uma IA. Com o MCP de documentação conectado, o agente consulta sozinho os guias, o kit e o Swagger enquanto escreve o código.

  • Endereço: https://www.gransoftweb.com/developers/mcp
  • Sem login: só documentação pública, nenhum dado de empresa.
  • Ferramentas: buscar na documentação, ler um guia, listar métodos e ver o detalhe de um método no Swagger.
  • Claude e ChatGPT: adicione um conector personalizado com o mesmo endereço.
Quer usar o GransoftWeb pela IA, sem programar (consultar estoque, criar orçamentos pelo chat)? Esse é o MCP de operações, em https://www.gransoftweb.com/API/mcp, que entra com o seu login do sistema.

Antes de programar

As regras da API que toda integração precisa seguir

A IA encontra tudo isso na documentação, mas vale conhecer para conferir o código que ela escrever.

userHash no corpo

Toda chamada é POST {Servidor}/API/{Metodo} com JSON. O userHash vai no corpo, nunca no código-fonte ou no navegador.

Erros com HTTP 200

A API responde 200 mesmo quando falha. O resultado está no campo Erro: verifique-o antes de usar os dados.

50 chamadas por minuto

O limite é por usuário. Acima dele, espere alguns segundos e repita. O kit já controla o ritmo.

Teste com dados de teste

Gravações (orçamentos, agendas, cadastros) acontecem na hora. Use o usuário de integração e clientes de teste.

Perguntas frequentes

Ajuda, mas não é obrigatório para começar. A IA escreve o código a partir da documentação; você precisa saber descrever o que quer, rodar o resultado e conferi-lo no GransoftWeb. Para colocar em produção, recomendamos a revisão de alguém com experiência.

Qualquer uma que faça requisições HTTP com JSON. O kit pronto é em Node.js (JavaScript), e a IA consegue adaptá-lo para Python, PHP, C# ou outra linguagem seguindo as mesmas regras.

Peça ao administrador da sua empresa um usuário para a integração. Entre com ele no GransoftWeb e abra server1.gransoftweb.com/API: a página mostra a sua chave de teste e a URL base. Aplicações em que cada pessoa entra com o próprio login usam o método ObterAutenticacao.

O MCP de documentação ensina a IA a criar aplicações que usam a API: é público e não acessa dados. O MCP de operações (/API/mcp) deixa a IA usar o sistema por você, com o seu login: consultar estoque, criar orçamentos e agendar visitas pelo chat.

A integração tem as mesmas permissões do usuário do userHash e só usa os métodos publicados na API. Emissão de notas fiscais e operações financeiras devem ser integradas com acompanhamento do suporte da Gransoft.