Produto | Linx DMS |
---|---|
Menu | - |
Data |
|
Autor | |
Área | Linx DMS |
Este documento tem como finalidade documentar a utilização da API com as funcionalidades utilizadas no processo de pós vendas através de uma aplicação móvel.
Esta funcionalidade pode ser utilizada por qualquer parceiro da Linx que possua um acordo para a utilização desta API, juntamente com os clientes.
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 no contexto de pós vendas através de uma aplicação móvel:
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=/Faturamento/CondicoesPagamento/ObterLista/Oficina/1/1/458 | ||||
---|---|---|---|---|---|
Método | GET | ||||
Header |
|
Faturamento
Atualizar opt-in/opt-out do cliente
Rota | v2?function=/Faturamento/Cliente/AtualizaOptInCliente |
---|---|
Método | POST |
Descrição | Endpoint responsável por atualizar o aceite de contato do cliente. |
Observação | - |
Request | { "CodigoCliente": 0, "OptIn": true } |
Response |
Consulta condições de pagamento
Rota | v2?function=/Faturamento/CondicoesPagamento/ObterLista/Oficina/{Empresa}/{Revenda}/{Contato} |
---|---|
Método | GET |
Descrição | Endpoint responsável por retornar uma lista com as condições de pagamento aptas a serem utilizadas para a empresa, revenda e contato consultados. |
Observação | - |
Request | - |
Response |
Consulta vendedores
Rota | v2?function=/Faturamento/Cadastros/Vendedores/FatMntVendedor/ObterVendedores/{Empresa}/{Revenda} |
---|---|
Método | GET |
Descrição | Endpoint responsável por retornar uma lista dos vendedores da empresa e revenda consultada. |
Observação | - |
Request | - |
Response |
Consulta usuários
Rota | v2?function=/Faturamento/Cadastros/Vendedores/FatMntVendedor/ListaUsuarios |
---|---|
Método | GET |
Descrição | Endpoint responsável por retornar uma lista de usuários. |
Observação | - |
Request | - |
Response |
Mobile
Consulta peças
Rota | v2?function=/CheckinOficina/BuscarPecas |
---|---|
Método | POST |
Descrição | Endpoint responsável por retornar uma lista com peças em estoque consultadas. |
Observação | Neste endPoint é necessário verificar o código de erro retornado na propriedade Resposta.Erro. Quando retornado diferente de 0 houve erros. |
Request | { "Filial": { //Exemplo: 1.1 "CodigoFilial": "string", //Exemplo: NISS "Bandeira": "string" }, "CodigoAgenda": "string", "Descricao": "string", "CodigoUsuario": "string", "PrecoSiteVW": true } |
Response |
Consulta serviços
Rota | v2?function=/CheckinOficina/BuscarServicos |
---|---|
Método | POST |
Descrição | Endpoint responsável por retornar uma lista com os serviços consultados. |
Observação | Neste endPoint é necessário verificar o código de erro retornado na propriedade Resposta.Erro. Quando retornado diferente de 0 houve erros. |
Request | { "Filial": { //Exemplo: 1.1 "CodigoFilial": "string", //Exemplo: NISS "Bandeira": "string" }, "Descricao": "string", "CodigoModeloVeiculo": "string" } |
Response |
Oficina
Consulta agenda dos consultores
Rota | v2?function=/Oficina/CheckinOficinaMetodos/CarregarAgendasApollo |
---|---|
Método | POST |
Descrição | Endpoint responsável por retornar uma lista com as os agendamentos realizados na data informada para a empresa e revenda consultadas. |
Observação | Neste endPoint é necessário verificar o código de erro retornado na propriedade Resposta.Erro. Quando retornado diferente de 0 houve erros. |
Request | { "Empresa": 0, "Revenda": 0, "DataAgenda": "2022-04-13T16:32:40.913Z", //Exemplo: NISS "Bandeira": "string" } |
Response |
Consulta atendimento
Rota | v2?function=/Oficina/Atendimento/{Empresa}/{Revenda}/{Contato} |
---|---|
Método | GET |
Descrição | Endpoint responsável por retornar o atendimento da empresa e revenda consultada. |
Observação | - |
Request | - |
Response |
Consulta categorias de ordem de serviço
Rota | v2?function=/Oficina/CheckinOficinaMetodos/ListaCategoriaOS |
---|---|
Método | POST |
Descrição | Endpoint responsável por retornar uma lista com as categorias de ordem de serviço aptas a serem utilizadas pela empresa, revenda e contato consultados. |
Observação | Neste endPoint é necessário verificar o código de erro retornado na propriedade Resposta.Erro. Quando retornado diferente de 0 houve erros. |
Request | { "Empresa": 0, "Revenda": 0, "Contato": 0 } |
Response |
Consulta cliente
Rota | v2?function=/Oficina/CheckinOficinaMetodos/BuscarClienteCheckin |
---|---|
Método | POST |
Descrição | Endpoint responsável por retornar as informações do cliente consultado. |
Observação | Caso for enviado na requisição o valor da propridade CodigoCliente diferente de zero, a busca pelo cliente ocorrerá pelo código informado. Caso contrário irá buscar o cliente pela propriedade Cgccpf e Tppessoa. Neste endPoint é necessário verificar o código de erro retornado na propriedade Resposta.Erro. Quando retornado diferente de 0 houve erros. |
Request | { "Cgccpf": "string", //F -> Fisica J-> Juridica "Tppessoa": "string", "CodigoCliente": 0 } |
Response |
Consulta mecânicos
Rota | v2?function=/Oficina/Mecanico/ObterListaMecanico/{Empresa}/{Revenda} |
---|---|
Método | GET |
Descrição | Endpoint responsável por retornar uma lista com os mecânicos da empresa e revenda consultadas. |
Observação | - |
Request | - |
Response |
Consulta motivos de paralização do serviço do CDT
Rota | v2?function=/Oficina/CDT/ObterMotivoParalizarCDT/{Empresa}/{Revenda} |
---|---|
Método | GET |
Descrição | Endpoint responsável por retornar uma lista com os motivos de paralização de serviço do CDT |
Observação | - |
Request | - |
Response |
Consulta ordem de serviço
Rota | v2?function=/Oficina/OrdemServico/{Empresa}/{Revenda}/{NroOs} |
---|---|
Método | GET |
Descrição | Endpoint responsável por retornar a ordem de serviço da empresa e revenda consultada. |
Observação | - |
Request | - |
Response |
Consulta ordens de serviço
Rota | v2?function=/Oficina/OrdemServico/ListaSimples |
---|---|
Método | POST |
Descrição | Endpoint responsável por retornar uma lista com as ordens de serviço consultadas de acordo com o filtro realizado. |
Observação | Se a consulta ocorrer somente pela Empresa e Revenda serão retornadas as ordens de serviço com data de abertura a partir do primeiro dia do mês atual. |
Request | { "Empresa": 0, "Revenda": 0, "NomeCliente": "string", //Enviar null caso não queira pesquisar pelo NroOs "NroOs": 0, "Chassi": "string", "Placa": "string", //Enviar null caso não queira pesquisar pela Aberta "Aberta": true, //Enviar null caso não queira pesquisar pela DataAberturaInicio "DataAberturaInicio": "2022-04-13T16:34:43.504Z", //Enviar null caso não queira pesquisar pela DataAberturaFinal "DataAberturaFinal": "2022-04-13T16:34:43.504Z" } |
Response |
Consulta tipos de serviços
Rota | v2?function=/Oficina/Cadastros/OfiTipoServico/ObterListaSimples/{Empresa}/{Revenda} |
---|---|
Método | GET |
Descrição | Endpoint responsável por retornar uma lista com os tipos de serviços da empresa e revenda consultadas. |
Observação | - |
Request | - |
Response |
Consulta veículo
Rota | v2?function=/Oficina/CheckinOficinaMetodos/BuscarVeiculo |
---|---|
Método | POST |
Descrição | Endpoint responsável por retornar as informações do veículo consultado. |
Observação | Neste endPoint é necessário verificar o código de erro retornado na propriedade Resposta.Erro. Quando retornado diferente de 0 houve erros. |
Request | { "Empresa": 0, "Revenda": 0, "Placa": "string", "Chassi": "string" } |
Response |
Gerar ordem de serviço por tipo
Rota | v2?function=/Oficina/CheckinOficinaMetodos/GerarOSPorTipo |
---|---|
Método | POST |
Descrição | Endpoint responsável por gerar ordens de serviço por tipo. |
Observação | - |
Request | { "Empresa": 0, "Revenda": 0, "UsuarioLogado": 0, "Cliente": 0, "Contato": 0, "Modelo": "string", //Somente números. "Kilometragem": "string", "Chassi": "string", //Somente números. "NroPrisma": "string", "CorPrisma": "string", "DataEmissao": "2022-04-04T20:13:41.393Z", "HoraEmissao": "2022-04-04T20:13:41.393Z", "HoraConclusao": "2022-04-04T20:13:41.393Z", //Data prevista. "DataConclusao": "2022-04-04T20:13:41.393Z", "HoraInicioServico": "2022-04-04T20:13:41.393Z", "DataInicioServico": "2022-04-04T20:13:41.393Z", //0 -> Vazio 1 -> 1/4 2 -> 1/2 3 -> 3/4 4 -> Cheio 5 -> 1/8 6 -> 3/8 7 -> 5/8 8 -> 7/8 "NivelCombustivel": 0, "CategoriaOSExt": "string", "CategoriaOSInt": "string", "CategoriaOSGar": "string", "CategoriaOSRev": "string", //Identificador do motivo - somente números "MotivoAtendimento": "string", "ResponsavelVeiculo": "string", "Observacao": "string", "Perguntas": { //S/N - Caso cliente tenha contrato de manutenção, enviar "S" para liberar abertura de OS "PerguntaLiberadoContratoManutencao": "string", //S/N - Caso UsuarioLogado não tenha permissão 143, enviar "S" para liberar abertura de OS "PerguntaAutorizacaoAtendimento": "string", //S/N - Caso Pârametro "Utiliza Industrializacao" esteja marcado no sistema, enviar "S" para liberar abertura de OS "PerguntaMecanicoUsuario": "string", //S/N - Caso queira enviar SMS para cliente "PerguntaGeraContato": "string" }, "CodigoAgenda": 0 } |
Response |
Gerar ordem de serviço única
Rota | v2?function=/Oficina/CheckinOficinaMetodos/GerarOSUnica |
---|---|
Método | POST |
Descrição | Endpoint responsável por gerar uma ordem de serviço única. |
Observação | - |
Request | { "Empresa": 0, "Revenda": 0, "UsuarioLogado": 0, "Cliente": 0, "Contato": 0, "Modelo": "string", //Somente números. "Kilometragem": "string", "Chassi": "string", //Somente números. "NroPrisma": "string", "CorPrisma": "string", "DataEmissao": "2022-04-04T20:13:41.393Z", "HoraEmissao": "2022-04-04T20:13:41.393Z", "HoraConclusao": "2022-04-04T20:13:41.393Z", //Data prevista. "DataConclusao": "2022-04-04T20:13:41.393Z", "HoraInicioServico": "2022-04-04T20:13:41.393Z", "DataInicioServico": "2022-04-04T20:13:41.393Z", //0 -> Vazio 1 -> 1/4 2 -> 1/2 3 -> 3/4 4 -> Cheio 5 -> 1/8 6 -> 3/8 7 -> 5/8 8 -> 7/8 "NivelCombustivel": 0, "CategoriaOS": "string", //Identificador do motivo - somente números "MotivoAtendimento": "string", "ResponsavelVeiculo": "string", "Observacao": "string", "Perguntas": { //S/N - Caso cliente tenha contrato de manutenção, enviar "S" para liberar abertura de OS "PerguntaLiberadoContratoManutencao": "string", //S/N - Caso UsuarioLogado não tenha permissão 143, enviar "S" para liberar abertura de OS "PerguntaAutorizacaoAtendimento": "string", //S/N - Caso Pârametro "Utiliza Industrializacao" esteja marcado no sistema, enviar "S" para liberar abertura de OS "PerguntaMecanicoUsuario": "string", //S/N - Caso queira enviar SMS para cliente "PerguntaGeraContato": "string" }, "CodigoAgenda": 0 } |
Response |
Inserir peça na ordem de serviço
Rota | v2?function=/Oficina/OrdemServico/MntOrdemServico/IncluiPecaOS |
---|---|
Método | POST |
Descrição | Endpoint responsável por inserir uma peça na ordem de serviço. |
Observação | - |
Request | { "contato": 0, "Mecanico": 0, "dadosDoItem": { "ItemEstoque": 0, "ContadorItem": 0 }, "detalhesDesconto": { "descontoPercentual": 0 }, "dadosOrigem": { "configuracaoOrigem": { "Empresa": 0, "Revenda": 0, "Usuario": 0, "CodigoOrigem": 0 }, "parametrosSelecao": { "Solicitacao": 0, "CodigoKit": 0 } } } |
Response |
Inserir serviço na ordem de serviço
Rota | v2?function=/Oficina/OrdemServico/MntOrdemServico/IncluiServicoOS |
---|---|
Método | POST |
Descrição | Endpoint responsável por inserir um serviço na ordem de serviço. |
Observação | - |
Request | { "Usuario": 0, "Empresa": 0, "Revenda": 0, "Contato": 0, "NroSolicitacao": 0, "NroLancamento": 0, "NroOs": 0, "Kit": 0, "Servico": 0, "Quantidade": 0, "MaoDeObra": "string", "Descricao": "string", "ValUnitario": 0, "ValDesconto": 0, "Mecanico": 0 } |
Response |
Inserir solicitação na ordem de serviço
Rota | v2?function=/Oficina/Solicitacao/IncluiSolicitacaoOS |
---|---|
Método | POST |
Descrição | Endpoint responsável por incluir uma solicitação na ordem de serviço |
Observação | Retorna o número da solicitação. |
Request | { "Empresa": 0, "Revenda": 0, "Contato": 0, "NroSolicitacao": 0, "DesSolicitacao": "string", "Situacao": 0, "TipoServico": "string", "IdVwbCorServico": 0, "MotivoCancelamento": 0, "DtaInclusao": "2022-04-06T19:03:49.868Z" } |
Response |
Lançar CDT / Lançar apontamento de horas trabalhada
Rota | v2?function=/Oficina/LancamentoCDT/LancarCDT |
---|---|
Método | POST |
Descrição | Endpoint responsável por realizar o lançamento de CDT. |
Observação | Caso não retorne nenhuma string o lançamento ocorreu com sucesso. |
Request | { "Empresa": 0, "Revenda": 0, "Lancamentos": [ { "CodigoMecanico": 0, "DataProcessamento": "string", "NroOs": 0, "NroLancamento": 0, "DataInicioCDT": "2022-04-04T20:03:12.921Z", "DataFimCDT": "2022-04-04T20:03:12.921Z", "CodigoUsuario": 0, "ManterAberto": true, //Somente números. "Motivo": "string" } ] } |
Response |
Manter dados do check-in
Rota | v2?function=/Oficina/CheckinOficinaMetodos/ManterCheckinApollo |
---|---|
Método | POST |
Descrição | Endpoint responsável por incluir ou alterar os dados do check-in. |
Observação | Neste endPoint é necessário verificar o código de erro retornado na propriedade Resposta.Erro. Quando retornado diferente de 0 houve erros. |
Request | { "Empresa": 0, "Revenda": 0, "CodigoUsuario": "string", "CodigoAgenda": "string", //I -> Inserir A -> Alterar "Modo": "string", //Obrigatório no modo I "CodigoConsultor": "string", "Checkin": { "CodigoCheckin": 0, "CodigoTipoVeiculo": 0, "PlacaVeiculo": "string", "Veiculo": "string", "Proprietario": "string", //0 -> Vazio 1 -> 1/4 2 -> 1/2 3 -> 3/4 4 -> Cheio 5 -> 1/8 6 -> 3/8 7 -> 5/8 8 -> 7/8 "NivelCombustivel": 0, "Quilometragem": 0, "NumeroPrisma": 0, "CorPrisma": "string", "Solicitacoes": [ { "DescricaoSolicitacao": "string", "CodigoTipoServico": "string", "Excluida": true, "Itens": [ { "CodigoItem": "string", //PCA -> Peça SRV -> Serviço "TipoItem": "string", //Valor separado por . "ValorUnitario": "string", //Valor separado por . "QuantidadeItem": "string", "CodigoPacote": "string", "NroLancamento": 0 } ], "CodigoSolicitacaoOrigem": 0 } ], "Observacao": "string", "CodigosItemChecklistCategoria": [ { "Itens": [ { "CodigoItemChecklist": 0, "Ok": true, "Reparar": true, "Observacao": "string", } ] } ] } } |
Response |
Manter dados do cliente
Rota | v2?function=/Oficina/CheckinOficinaMetodos/ManterDadosCliente |
---|---|
Método | POST |
Descrição | Endpoint responsável por incluir ou alterar os dados do cliente. |
Observação | Neste endPoint é necessário verificar o código de erro retornado na propriedade Resposta.Erro. Quando retornado diferente de 0 houve erros. |
Request | { "Empresa": 0, "Revenda": 0, //I -> Inserir A -> Alterar "Modo": "string", "CodigoUsuario": 0, "Cliente": { "CodigoCliente": 0, "NomeCliente": "string", "DDDTelefone": "string", "Telefone": "string", "DDDCelular": "string", "Celular": "string", "Email": "string", "Endereco": "string", "Complemento": "string", "Cidade": "string", //UF "Estado": "string", "Cep": "string", //dd/MM/yyyy "DataNascimento": "string", "Bairro": "string", //1 -> Telefone 2 -> E-mail 3 -> SMS 4 -> WhatsApp "FormaContato": 0, //CNPJ/CPF "Cgccpf": "string", //F -> Pessoa Física J -> Pessoa Jurídica "Tppessoa": "string", "TipoVia": "string" } } |
Response |
Manter dados do veículo
Rota | v2?function=/Oficina/CheckinOficinaMetodos/ManterDadosVeiculo |
---|---|
Método | POST |
Descrição | Endpoint responsável por incluir ou alterar os dados do veículo. |
Observação | Neste endPoint é necessário verificar o código de erro retornado na propriedade Resposta.Erro. Quando retornado diferente de 0 houve erros. |
Request | { "Empresa": 0, "Revenda": 0, //I -> Inserir A -> Alterar "Modo": "string", "Veiculo": { "NomeCliente": "string", "CodigoCliente": 0, "Chassi": "string", "AnoFabricacao": 0, "AnoModelo": 0, "DataVenda": "2022-03-23T12:49:31.253Z", "Quilometragem": 0, "Placa": "string", //Código da cor do veículo "CorExterna": "string", //A -> Alcool B -> Bi-Combustível D -> Diesel G -> Gasolina O -> Outros S -> Gás T -> Tri-Combustível "TipoCombustivel": "string" }, "CodigoUsuario": "string" } |
Response |
Veículo
Consulta combustíveis
Rota | v2?function=/Veiculos/Cadastros/ManutencaoDeCombustiveis/ObterLista |
---|---|
Método | GET |
Descrição | Endpoint responsável por retornar uma lista com os combustíveis cadastrados. |
Observação | - |
Request | - |
Response |
Consulta cores
Rota | v2?function=/Veiculo/Cores/{Empresa} |
---|---|
Método | GET |
Descrição | Endpoint responsável por retornar uma lista com as cores de veículo da empresa consultada. |
Observação | - |
Request | - |
Response |
Consulta família de veículo
Rota | v2?function=/Veiculo/Familia/Obter/{Empresa}/{Familia} |
---|---|
Método | GET |
Descrição | Endpoint responsável por retornar a família de veículo da empresa consultada. |
Observação | - |
Request | - |
Response |
Consulta famílias de veículos
Rota | v2?function=/Veiculo/Familia/ObterLista/{Empresa} |
---|---|
Método | GET |
Descrição | Endpoint responsável por retornar uma lista com as famílias de veículo da empresa consultada. |
Observação | - |
Request | - |
Response |
Consulta modelo de veículos
Rota | v2?function=/Veiculo/Modelo/{Empresa}/{Modelo} |
---|---|
Método | GET |
Descrição | Endpoint responsável por retornar o modelo de veículo da empresa consultada. |
Observação | - |
Request | - |
Response |
Consulta modelos de veículos
Rota | v2?function=/Veiculo/Modelo/Lista/{Empresa}/{Modelo?} |
---|---|
Método | GET |
Descrição | Endpoint responsável por retornar uma lista com os modelos de veículos da empresa consultada. |
Observação | Na rota, o Modelo? representa que não é obrigatório enviar o código do modelo para consulta. |
Request | - |
Response |