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 OpenAPIConvençõ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 artigosGET /api/v1/precos— Listar preços de vendaGET /api/v1/colors— Obter coresGET /api/v1/extraFields— Listar campos extraGET /api/v1/family— Listar famíliasGET /api/v1/familychildren— Listar sub-famíliasGET /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 artigoGET /api/v1/products/colorsizes— Cores/Tamanhos do artigoGET /api/v1/products/count— Total de artigos (count)GET /api/v1/products/descriptions— Descrições do artigo por idiomaGET /api/v1/products/extraFields— Listar Campos Extra ArtigoGET /api/v1/products/sizeCount— Total de tamanhos do artigo (sizeCount)GET /api/v1/sizes— TamanhosGET /api/v1/unitofmeasure— Unidades de medidaGET /api/v1/test— Test WebserviceGET /api/v1/SageVersion— Versão da instalação Sage 50cGET /api/v1/products/{ItemID}/image— Imagem do artigoGET /api/v1/products/archives— Anexos públicos do artigoGET /api/v1/products/archives/{archiveGuid}— Conteúdo do anexo de artigoGET /api/v1/rotacao— Consultar a rotação de stockGET /api/v1/stocks— Consultar stock por armazémGET /api/v1/movimentos-stock— Listar movimentos de stockGET /api/v1/products/itemproperties— Listar propriedades do artigoGET /api/v1/products/itempropertiesCount— Total propriedades do artigoGET /api/v1/products/stock— Listar stock artigo por refªGET /api/v1/products/stockproperties— Listar stock artigo por propriedadesGET /api/v1/warehouses— Listar armazénsGET /api/v1/warehousesstocks— Listar stock artigos por armazémGET /api/v1/documents/stock— Documentos de stockGET /api/v1/vendas— Consultar faturação por mêsGET /api/v1/documentos-venda— Listar documentos de vendaGET /api/v1/margens— Consultar margens por artigoGET /api/v1/carrier— Obter TransportesGET /api/v1/DiscountDefinition— Obter lista campanhasGET /api/v1/DiscountDefinition/{DiscountID}— Obter campanhaGET /api/v1/DiscountDefinition/{DiscountID}/DiscountEligibleItem— Obter descontos por artigoGET /api/v1/DiscountDefinition/{DiscountID}/DiscountScalingItem— Obter escalões de descontoGET /api/v1/loadunloadplace— Listar cargas/descargasGET /api/v1/salesman— VendedoresGET /api/v1/documents/status/all— Lista de estados do documentoGET /api/v1/series— Listar sériesGET /api/v1/documents/series— Lista de sériesGET /api/v1/documents/voucher— Consultar talãoGET /api/v1/documents— Lista de documentosGET /api/v1/documents/sale— Listar documento vendaGET /api/v1/documents/status— Estado do documentoGET /api/v1/checkDocument— Verificar documentoGET /api/v1/documents/excel— Exportar um documento para ExcelGET /api/v1/documents/pdf— Ler o PDF fiscal arquivadoGET /api/v1/compras— Consultar compras por fornecedor e mêsGET /api/v1/documentos-compra— Listar documentos de compraGET /api/v1/fornecedores— Listar fornecedoresGET /api/v1/products/suppliers— Fornecedores do artigoGET /api/v1/suppliers/address/{SupplierID}— Morada do fornecedorGET /api/v1/suppliers/extraFields— Campo extra do fornecedorGET /api/v1/suppliers— FornecedoresGET /api/v1/documents/purchase— Documentos de comprasGET /api/v1/clientes— Listar clientesGET /api/v1/historico-cliente— Consultar histórico de um clienteGET /api/v1/CountryCodes— Obter lista paísesGET /api/v1/languageCodes— Listar IdiomasGET /api/v1/zones— ZonasGET /api/v1/customers/groups— Listar grupos de clienteGET /api/v1/customers/address/{PartyID}— Moradas do clienteGET /api/v1/customers/email— Email do clienteGET /api/v1/customers/contacts/{PartyID}— Contactos do clienteGET /api/v1/customers/bank-accounts— Contas bancárias do clienteGET /api/v1/customers/extrafields/{PartyID}— Campos extra do clienteGET /api/v1/vehicles— Listar veículosGET /api/v1/vehicles/makes— Marcas de veículosGET /api/v1/vehicles/models— Modelos de veículosGET /api/v1/customers/contracts— Obter avençasGET /api/v1/customers— Listar clientes por refªGET /api/v1/financeiro-clientes— Consultar contas a receberGET /api/v1/financeiro-fornecedores— Consultar contas a pagarGET /api/v1/payment— Obter pagamentosGET /api/v1/taxes— TaxasGET /api/v1/taxes/taxrate— Taxa por grupo IVA (taxrate)GET /api/v1/taxeTable— Tabela impostosGET /api/v1/tender— ModalidadesGET /api/v1/till— Listar caixasGET /api/v1/documents/ledgeraccount— Documento ledger account (Sage)GET /api/v1/customers/pending/{PartyID}— Listar Pendentes clienteGET /api/v1/suppliers/pending— Pendentes de fornecedor (lista)GET /api/v1/suppliers/pending/{SupplierID}— Pendentes de um fornecedorGET /api/v1/suppliers/ledgeraccount— Linhas ledger fornecedor (sem agregar)GET /api/v1/customers/cc— Listar Conta-corrente clientesGET /api/v1/documents/account— Listar documentos de conta-correnteGET /api/v1/saldo— Saldo do clienteGET /api/v1/suppliers/cc— Conta-corrente fornecedores (agregada)GET /api/v1/suppliers/pendentes— Pendentes (alias pendentes)GET /api/v1/pendentes— Listar documentos pendentes clienteGET /api/v1/suppliers/extrato— Extrato fornecedorGET /api/v1/extrato— Listar extrato clienteGET /api/v1/SystemSettings— SystemSettingsGET /api/v1/SystemSettings/Application— Application da instalação SageGET /api/v1/SystemSettings/SystemInfo— SystemInfo da instalação SageGET /api/v1/SystemSettings/WorkstationInfo— WorkstationInfo da instalação SageGET /api/v1/version— Versão do gatewayGET /api/v1/log— Consultas recentes do consumidor
Testar no Postman
Descarregar coleção do PostmanImporte 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.