automcp

Documentação da API

Consulte artigos, stocks, vendas, compras e contas do Sage 50c. A chave da aplicação identifica a empresa e as áreas a que tem acesso.

Endpoints do gateway

Descarregar OpenAPI
Convenções da API

Consultas HTTPS com respostas JSON. Use uma chave de consumidor emitida para uma empresa e para as áreas autorizadas. A empresa é determinada pelo gateway a partir da chave.

Envie os filtros na query e mantenha o corpo do pedido vazio. Indique apenas os parâmetros documentados e, quando presentes, um único valor por nome. Todos os caminhos publicados começam por /api/v1/. Os relatórios paginados, como /api/v1/artigos, devolvem offset, limite e dados. Nas restantes operações, consulte os parâmetros e o formato de resposta de cada GET.

Num caminho desconhecido, uma chave válida recebe HTTP 404 (recurso_desconhecido). Um método diferente de GET num recurso conhecido devolve HTTP 405 (metodo_nao_permitido) com o cabeçalho Allow: GET.

Se receber 503 fonte_indisponivel, confirme que a base ligada ao agente contém as tabelas e colunas da operação e que a conta do serviço tem acesso de leitura.

  • GET /api/v1/artigos — Listar artigos
  • GET /api/v1/precos — Listar preços de venda
  • GET /api/v1/colors — Obter cores
  • GET /api/v1/extraFields — Listar campos extra
  • GET /api/v1/family — Listar famílias
  • GET /api/v1/familychildren — Listar sub-famílias
  • GET /api/v1/prices — Linhas de preço (GET prices)
  • GET /api/v1/products — Listar artigo por Refª
  • GET /api/v1/products/colorCount — Obter total de cores do artigo
  • GET /api/v1/products/colorsizes — Cores/Tamanhos do artigo
  • GET /api/v1/products/count — Total de artigos (count)
  • GET /api/v1/products/descriptions — Descrições do artigo por idioma
  • GET /api/v1/products/extraFields — Listar Campos Extra Artigo
  • GET /api/v1/products/sizeCount — Total de tamanhos do artigo (sizeCount)
  • GET /api/v1/sizes — Tamanhos
  • GET /api/v1/unitofmeasure — Unidades de medida
  • GET /api/v1/test — Test Webservice
  • GET /api/v1/SageVersion — Versão da instalação Sage 50c
  • GET /api/v1/products/{ItemID}/image — Imagem do artigo
  • GET /api/v1/products/archives — Anexos públicos do artigo
  • GET /api/v1/products/archives/{archiveGuid} — Conteúdo do anexo de artigo
  • GET /api/v1/rotacao — Consultar a rotação de stock
  • GET /api/v1/stocks — Consultar stock por armazém
  • GET /api/v1/movimentos-stock — Listar movimentos de stock
  • GET /api/v1/products/itemproperties — Listar propriedades do artigo
  • GET /api/v1/products/itempropertiesCount — Total propriedades do artigo
  • GET /api/v1/products/stock — Listar stock artigo por refª
  • GET /api/v1/products/stockproperties — Listar stock artigo por propriedades
  • GET /api/v1/warehouses — Listar armazéns
  • GET /api/v1/warehousesstocks — Listar stock artigos por armazém
  • GET /api/v1/documents/stock — Documentos de stock
  • GET /api/v1/vendas — Consultar faturação por mês
  • GET /api/v1/documentos-venda — Listar documentos de venda
  • GET /api/v1/margens — Consultar margens por artigo
  • GET /api/v1/carrier — Obter Transportes
  • GET /api/v1/DiscountDefinition — Obter lista campanhas
  • GET /api/v1/DiscountDefinition/{DiscountID} — Obter campanha
  • GET /api/v1/DiscountDefinition/{DiscountID}/DiscountEligibleItem — Obter descontos por artigo
  • GET /api/v1/DiscountDefinition/{DiscountID}/DiscountScalingItem — Obter escalões de desconto
  • GET /api/v1/loadunloadplace — Listar cargas/descargas
  • GET /api/v1/salesman — Vendedores
  • GET /api/v1/documents/status/all — Lista de estados do documento
  • GET /api/v1/series — Listar séries
  • GET /api/v1/documents/series — Lista de séries
  • GET /api/v1/documents/voucher — Consultar talão
  • GET /api/v1/documents — Lista de documentos
  • GET /api/v1/documents/sale — Listar documento venda
  • GET /api/v1/documents/status — Estado do documento
  • GET /api/v1/checkDocument — Verificar documento
  • GET /api/v1/documents/excel — Exportar um documento para Excel
  • GET /api/v1/documents/pdf — Ler o PDF fiscal arquivado
  • GET /api/v1/compras — Consultar compras por fornecedor e mês
  • GET /api/v1/documentos-compra — Listar documentos de compra
  • GET /api/v1/fornecedores — Listar fornecedores
  • GET /api/v1/products/suppliers — Fornecedores do artigo
  • GET /api/v1/suppliers/address/{SupplierID} — Morada do fornecedor
  • GET /api/v1/suppliers/extraFields — Campo extra do fornecedor
  • GET /api/v1/suppliers — Fornecedores
  • GET /api/v1/documents/purchase — Documentos de compras
  • GET /api/v1/clientes — Listar clientes
  • GET /api/v1/historico-cliente — Consultar histórico de um cliente
  • GET /api/v1/CountryCodes — Obter lista países
  • GET /api/v1/languageCodes — Listar Idiomas
  • GET /api/v1/zones — Zonas
  • GET /api/v1/customers/groups — Listar grupos de cliente
  • GET /api/v1/customers/address/{PartyID} — Moradas do cliente
  • GET /api/v1/customers/email — Email do cliente
  • GET /api/v1/customers/contacts/{PartyID} — Contactos do cliente
  • GET /api/v1/customers/bank-accounts — Contas bancárias do cliente
  • GET /api/v1/customers/extrafields/{PartyID} — Campos extra do cliente
  • GET /api/v1/vehicles — Listar veículos
  • GET /api/v1/vehicles/makes — Marcas de veículos
  • GET /api/v1/vehicles/models — Modelos de veículos
  • GET /api/v1/customers/contracts — Obter avenças
  • GET /api/v1/customers — Listar clientes por refª
  • GET /api/v1/financeiro-clientes — Consultar contas a receber
  • GET /api/v1/financeiro-fornecedores — Consultar contas a pagar
  • GET /api/v1/payment — Obter pagamentos
  • GET /api/v1/taxes — Taxas
  • GET /api/v1/taxes/taxrate — Taxa por grupo IVA (taxrate)
  • GET /api/v1/taxeTable — Tabela impostos
  • GET /api/v1/tender — Modalidades
  • GET /api/v1/till — Listar caixas
  • GET /api/v1/documents/ledgeraccount — Documento ledger account (Sage)
  • GET /api/v1/customers/pending/{PartyID} — Listar Pendentes cliente
  • GET /api/v1/suppliers/pending — Pendentes de fornecedor (lista)
  • GET /api/v1/suppliers/pending/{SupplierID} — Pendentes de um fornecedor
  • GET /api/v1/suppliers/ledgeraccount — Linhas ledger fornecedor (sem agregar)
  • GET /api/v1/customers/cc — Listar Conta-corrente clientes
  • GET /api/v1/documents/account — Listar documentos de conta-corrente
  • GET /api/v1/saldo — Saldo do cliente
  • GET /api/v1/suppliers/cc — Conta-corrente fornecedores (agregada)
  • GET /api/v1/suppliers/pendentes — Pendentes (alias pendentes)
  • GET /api/v1/pendentes — Listar documentos pendentes cliente
  • GET /api/v1/suppliers/extrato — Extrato fornecedor
  • GET /api/v1/extrato — Listar extrato cliente
  • GET /api/v1/SystemSettings — SystemSettings
  • GET /api/v1/SystemSettings/Application — Application da instalação Sage
  • GET /api/v1/SystemSettings/SystemInfo — SystemInfo da instalação Sage
  • GET /api/v1/SystemSettings/WorkstationInfo — WorkstationInfo da instalação Sage
  • GET /api/v1/version — Versão do gateway
  • GET /api/v1/log — Consultas recentes do consumidor
Ler a especificação JSON

Importe a coleção em Import. A coleção já traz o endereço HTTPS da API para acesso pela Internet.

Em Variables, cole a chave de leitura de ficha.txt no valor local de token, sem o prefixo Bearer. Para outra instalação, ajuste baseUrl ao endereço HTTPS da ficha, retirando o /v1 final. A variável termina em /api e todos os pedidos da coleção acrescentam /v1/.

O certificado HTTPS do endereço público é validado pelo sistema. Mantenha a verificação SSL ativa.

Na pasta Primeiros testes, envie GET /api/v1/version para confirmar a chave. Com acesso a Artigos e preços, envie GET /api/v1/test para confirmar a ligação à fonte da empresa. O resultado esperado é 200 com {"ok":true}.

Primeira consulta

Para consultar artigos, use uma chave com acesso à área Artigos e preços. Consulte o endereço do gateway.

No PowerShell, defina AUTOMCP_API_TOKEN com a chave da sua ficha.

$url = 'https://automcp.cboxclub.com:8443/api/v1/artigos?limite=1'
$auth = 'header = "Authorization: Bearer {0}"' -f $env:AUTOMCP_API_TOKEN
$auth | curl.exe --config - $url

A resposta contém offset, limite e a lista dados. Se nenhum artigo corresponder ao filtro, dados vem vazio e o estado HTTP é 200.