Finalidade

Este documento tem como finalidade documentar a utilização da API com as funcionalidades utilizadas pelo parceiro ATRIA.

Aplicação

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.

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 exemplohttp://apolloapp01.brazilsouth.cloudapp.azure.com:5001/LinxDMSAPI/v2?function=/Parcerias/Atria/ConsultaQtdOSPorServico
MétodoPOST
Header
tokenc077addac0ec7c808732f5951b1cdaf93eecf49d83d850aa7f7da1dd1c32b75b4e9aeed3616180fe7c1337f737135a27
Content-Typeapplication/json

Lista de EndPoints

Leitura de Venda de Produtos + Estoque Atual (vendas de um período)

Rota/Parcerias/Atria/ConsultaVendasPecasEstoque
MétodoPOST
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
Status 200 
[
  {
    "EstoqueAtual": 0,
    "QtdVendido": 0,
    "Consultor": "string",
	"CodigoConsultor": 0,
    "Referencia": "string"
  }
]
Status 412 
string
Status 500 
{
  "MensagemDeErro": "string",
  "DetalhesDoErro": "string",
  "SqlOrigemErro": "string",
  "ParametrosSql": {},
  "TraceList": "string"
}

Leitura de Venda de Serviços (vendas de um período)

Rota/Parcerias/Atria/ConsultaVendasServicos
MétodoPOST
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
Status 200 
[
  {
    "QtdVendido": 0,
    "Consultor": "string",
    "CodigoConsultor": 0,
    "Referencia": "string"
  }
]
Status 412 
string
Status 500 
{
  "MensagemDeErro": "string",
  "DetalhesDoErro": "string",
  "SqlOrigemErro": "string",
  "ParametrosSql": {},
  "TraceList": "string"
}

Leitura de OS baseados em Tipo de OS (saber o número de OS abertas)

Rota/Parcerias/Atria/ConsultaQtdOSPorTipo
MétodoPOST
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
Status 200 
[
  {
    "QtdOS": 0,
    "Consultor": "string",
    "CodigoConsultor": 0,
    "Referencia": "string"
  }
]
Status 412 
string
Status 500 
{
  "MensagemDeErro": "string",
  "DetalhesDoErro": "string",
  "SqlOrigemErro": "string",
  "ParametrosSql": {},
  "TraceList": "string"
}

Leitura de OS Baseado em TMO/Serviço (saber o número de OS abertas)

Rota/Parcerias/Atria/ConsultaQtdOSPorServico
MétodoPOST
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
Status 200 
[
  {
    "QtdOS": 0,
    "Consultor": "string",
    "CodigoConsultor": 0,
    "Referencia": "string"
  }
Status 412 
string
Status 500 
{
  "MensagemDeErro": "string",
  "DetalhesDoErro": "string",
  "SqlOrigemErro": "string",
  "ParametrosSql": {},
  "TraceList": "string"
}
  • Sem rótulos