Este documento tem como finalidade documentar a utilização da API com as funcionalidades utilizadas pelo parceiro ATRIA.
Ambiente
Verifique o endereço do ambiente a ser utilizado na documentação Barramento.
Autenticação
O tipo de autenticação utilizada por estes endPoints é a Autenticação V2.
Abaixo segue a documentação dos endPoints disponibilizados na API para serem utilizados pelo parceiro ATRIA.
Exemplo de consumo da API
Abaixo segue um exemplo de como consumir a API utilizando o ambiente desejado e o token de autenticação:
Endereço de exemplo | http://apolloapp01.brazilsouth.cloudapp.azure.com:5001/LinxDMSAPI/v2?function=/Parcerias/Atria/ConsultaQtdOSPorServico | ||||
Método | POST | ||||
Header |
|
Lista de EndPoints
Leitura de Venda de Produtos + Estoque Atual (vendas de um período)
Rota | /Parcerias/Atria/ConsultaVendasPecasEstoque |
Método | POST |
Descrição | - |
Observação | Parâmetros Cnpj, DtaIni, DtaFim obrigatórios. Parâmetro DtaFim obrigatório ser após DtaIni. Tamanho máximo da string do item: 20. |
Request | { "Cnpj": "string", "DtaIni": "2023-04-26T17:27:38.232Z", "DtaFim": "2023-04-26T17:27:38.232Z", "Itens": [ "string" ] } |
Response |
Leitura de Venda de Serviços (vendas de um período)
Rota | /Parcerias/Atria/ConsultaVendasServicos |
Método | POST |
Descrição | - |
Observação | Parâmetros Cnpj, DtaIni, DtaFim obrigatórios. Parâmetro DtaFim obrigatório ser após DtaIni. Tamanho máximo da string do item: 15. |
Request | { "Cnpj": "string", "DtaIni": "2023-04-26T17:27:38.232Z", "DtaFim": "2023-04-26T17:27:38.232Z", "Itens": [ "string" ] } |
Response |
Leitura de OS baseados em Tipo de OS (saber o número de OS abertas)
Rota | /Parcerias/Atria/ConsultaQtdOSPorTipo |
Método | POST |
Descrição | - |
Observação | Parâmetros Cnpj, DtaIni, DtaFim obrigatórios. Parâmetro DtaFim obrigatório ser após DtaIni. Tamanho máximo da string do item: 6. |
Request | { "Cnpj": "string", "DtaIni": "2023-04-26T17:27:38.232Z", "DtaFim": "2023-04-26T17:27:38.232Z", "Itens": [ "string" ] } |
Response |
Leitura de OS Baseado em TMO/Serviço (saber o número de OS abertas)
Rota | /Parcerias/Atria/ConsultaQtdOSPorServico |
Método | POST |
Descrição | - |
Observação | Parâmetros Cnpj, DtaIni, DtaFim obrigatórios. Parâmetro DtaFim obrigatório ser após DtaIni. Tamanho máximo da string do item: 15. |
Request | { "Cnpj": "string", "DtaIni": "2023-04-26T17:27:38.232Z", "DtaFim": "2023-04-26T17:27:38.232Z", "Itens": [ "string" ] } |
Response |