# Referência: onde achar cada método

A API do GransoftWeb tem três fontes de referência, que se complementam.

| Fonte | Endereço | Para quê |
|---|---|---|
| **Guias** (este portal) | https://www.gransoftweb.com/developers | Tarefas completas passo a passo: autenticação, estoque, clientes, orçamento. Comece por aqui. |
| **Swagger** | http://www.server1.gepersistemas.com.br:8082/swagger/ui/index | Contrato dos métodos (Swagger 2.0): rotas, parâmetros e descrição. O JSON fica em `/swagger/docs/v1`. |
| **Catálogo de APIs** | https://www.server1.gransoftweb.com/API/ | Métodos por grupo (Cadastro, Vendas, Produção, Estoque, Financeiro, Fiscal, CRM, Agenda…), com testador e a sua chave de teste. |

Quando o Swagger e um guia divergirem, siga o guia e avise o suporte da Gransoft. Os guias foram conferidos no código do sistema.

## Métodos mais usados

| Tarefa | Método | Guia |
|---|---|---|
| Autenticar com e-mail e senha | `ObterAutenticacao` (em `https://www.gransoftweb.com`) | [Autenticação](autenticacao.md) |
| Listas de apoio (clientes, produtos, tabelas, pagamento…) | `ObterLista` | [Consultar clientes](guias/consultar-clientes.md) |
| Estoque de chapas | `ListaEstoqueChapas` | [Consultar estoque de chapas](guias/consultar-estoque-chapas.md) |
| Saldo de almoxarifado | `ListaItensAlmoxarifado` | Swagger |
| Preço de venda na tabela | `ConsultarPreco` | Swagger |
| Orçamentos e pedidos (consultar, criar, alterar) | `AcoesDocumentoVendaMarmoraria` | [Criar orçamento](guias/criar-orcamento.md) |
| Agenda de visitas (consultar, criar, alterar) | `AcoesAgendaUsuario` | Swagger |
| Ordens de serviço | `ListaOrdensServicosMarmoraria`, `DetalheOrdemServicoMarmoraria` | Swagger |
| Indicadores do painel | `GetDashboardData` | Swagger |
| Consulta de CEP | `ConsultaCEP` | Swagger |
| Cadastrar ou atualizar produtos (até 30 por chamada) | `CadastrarProdutos`, `AtualizarCadastroProdutos` | Catálogo de APIs, grupo Cadastro |

## Fora do escopo das integrações externas

Métodos dos grupos **Database**, **Importação** e **Fornecedor externo**, e os métodos marcados como "Administrador" no catálogo, são de uso interno da Gransoft e não são suportados para integrações de terceiros.

Emissão de documentos fiscais (NF-e, NFC-e, MDF-e, NFS-e) gera documentos com validade jurídica. Só integre com acompanhamento do suporte da Gransoft.