# Início Introdução desta documentação da API do Siprov. ### Integre com o Siprov e expanda as possibilidades com um dos melhores sistemas do mercado para prestadores de serviços, associações ou cooperativas. Com a nossa API, sua plataforma pode consumir nossas rotas (endpoints) para importar dados para sua plataforma/aplicativo ou você pode inserir os dados diretamente no nosso sistema Siprov para finalidades diversas, como: * Criar ou atualizar adesões ou contratos; * Cadastrar pessoas como associados, clientes, fornecedores, etc; * Gerar e atualizar títulos financeiros, inclusive com geração de boleto, PIX ou cobrança por cartão de crédito; * Registrar eventos, orçamentos, etc; * Registrar atendimentos (help desk); * Criar ou consultar rede de parceiros, clínicas e médicos para ofertas de benefícios, descontos; * Consultar ou criar leads no módulo de CRM; * Dentre outros. Consulte nossa documentação nos artigos a seguir na seção [Referência da API](/referencia-da-api/introducao-tecnica) ou veja cenários de aplicação tomando por base nosso [Guia de Implementação](/guia-de-implementacao/apresentacao). Recomendamos também a leitura do [artigo que relaciona as nomenclaturas](/ajuda/nomenclaturas) adotadas, que às vezes são bem específicas e podem não ser de conhecimento geral. Caso tenha alguma dúvida, você pode entrar em [contato conosco](/ajuda/contato). # Introdução Introdução de conceitos básicos para começar a trabalhar com nossa API. A seguir você verá a documentação da API do sistema **Siprov**. Primeiramente, deve ter ciência de que para conseguir usar nossa API, você deve possuir um usuário e senha. {% hint style="info" %} Obtenha seu **usuário** e **senha** com algum cliente usuário do **Siprov** (acesso em produção) ou entre em [contato conosco](/ajuda/contato) para obter um acesso exclusivo para teste (acesso em homologação). {% endhint %} Para uso em produção, você deve usar um usuário e senha criado em alguma base usuária do sistema. Quando o administrador criar seu acesso com algum email fornecido por você, uma senha temporária será enviada no email informado. Então, acesse o sistema **Siprov** em - que também vai constar nesse email - e efetue o primeiro acesso para fazer a troca da senha temporária por uma nova de uso exclusivo. {% hint style="info" %} A qualquer momento você pode redefinir a senha desse usuário no endereço acima.\ Ou pode recuperá-la no menu 'Esqueci minha senha' caso a tenha perdido ou esquecido. {% endhint %} Use o método '[/ext/autenticacao](/referencia-da-api/introducao-tecnica/autenticacao)' para gerar o 'token' a ser usado nos demais métodos da API. # Configuração do Acesso Instruções sobre como configurar e liberar o acesso à API. Quando um usuário administrador na respectiva base do sistema criar o seu acesso para consumo da API, deve ter em mente que duas parametrizações relacionadas à permissão e segurança devem ser feitas. ### 1. Criação do Perfil Dentro do sistema Siprov todo **usuário** tem um **perfil** vinculado. Esse perfil determina a quais recursos o respectivo usuário terá acesso. No caso de um usuário exclusivamente criado para uso na API, dentro da tela **Cadastro de Perfil** existirá uma seção nomeada **API** na qual está listada todos os métodos (endpoints) que tal acesso poderá usar. \ Isso serve para restringir o acesso e uso somente a um ou outro recurso. Por exemplo, às vezes você quer liberar somente métodos relacionados à cliente ou contratos, mas não à parte financeira. Dessa forma, mesmo ele tendo um usuário e visualizando toda a documentação, ele só conseguirá usar efetivamente métodos que foram liberados no respectivo perfil. ### 2. Configuração da API Além disso, pode ser que você queira delimitar o acesso a dados específicos dentro dos métodos, ainda mais no cenário atual que as empresas devem estar muito atentas às normas da [LGPD](http://www.planalto.gov.br/ccivil_03/_ato2015-2018/2018/lei/l13709.htm). Então, na tela **Configuração da API** (dentro do Siprov acesse o menu '*Ferramentas > Complementos > API*), o usuário consegue ver quais dados cada método expõe no retorno da consulta, inserção ou edição efetuada. Assim, o usuário conseguirá marcar ou desmarcar algum campo para ser disponibilizado ou não nesse retorno. Isso é útil em cenários em que o usuário administrador da base não quer dispor, por exemplo, de dados sensíveis da sua base, como CPF, data de nascimento, email, telefone, etc. Dito isso, mesmo o usuário tendo acesso ao método, não quer dizer que ele acessará todos os dados que poderiam estar disponíveis. Caso o usuário administrador tenha dúvida de como efetuar tais configurações, só [entrar em contato com nossa equipe](/ajuda/contato). # Teste Instruções sobre como efetuar os testes na nossa API. Para realizar os testes antes de qualquer implementação, recomendamos o uso do **Postman**, que é uma plataforma para desenvolvedores projetar, construir, testar e iterar suas APIs. Para usar o Postman, você pode baixá-lo ou usar a versão online: 1. Download: 2. Online: Após criar seu acesso, baixe o arquivo JSON da nossa API que segue o padrão [OpenAPI](https://swagger.io/specification/).\ Baixe pelo endereço [Especificação (OpenAPI)](https://acesso.siprov.com.br/siprov-api/openapi.json), que também segue no menu à esquerda. Se o arquivo não baixar, só clicar com o botão direito e salvar como "openapi.json". Dentro do Postman, vá em 'Importar > Arquivo' e busque o arquivo baixado. Então, a coleção do **Siprov API** será criada dentro do seu ambiente de trabalho (workspace) e você poderá efetuar os testes em todos os métodos que tenha acesso. # Erros Erros que podem ser retornados nas requisições. Ao fazer alguma requisição em nossa API, será emitida uma resposta com status no padrão [códigos de status HTTP](https://developer.mozilla.org/pt-BR/docs/Web/HTTP/Status). Uma requisição bem sucedida retorna o status `200 OK` com uma resposta em formato JSON. Já uma requisição que não teve sucesso vai retornar algum status com código iniciado em 4. Por exemplo, o status `401 Unauthorized`. A resposta será em texto simples (plain text) ou JSON. Para o método de [Autenticação](https://doc.siprov.com.br/referencia-da-api/introducao-tecnica/referencia/autenticacao), temos os seguintes erros: 1. **Mensagem**: `Credenciais inválidas.`\ **Solução**: Informe corretamente o usuário ou verifique novamente com seu contato. 2. **Mensagem**: `Senha incorreta.`\ **Solução**: . Informe a senha correta ou altere para uma nova. Para os demais métodos da API, destacamos abaixo os erros mais comuns, geralmente relacionados à autenticação. Mas também pode ocorrer erro relacionado ao informe incorreto dos parâmetros (param) ou corpo (payload) das requisições. Nesses casos, o sistema retornará com o descritivo do erro. ### Erros comuns 1. **Mensagem**: `Bearer Token ausente!`\ **Problema**: O 'Bearer Token' não foi informado no cabeçalho (header) 'Authorization' da requisição.\ **Solução**: Gere o token no método 'Autenticação' e o informe no cabeçalho da requisição desejada. 2. **Mensagem**: `Bearer Token inválido!`\ **Problema**: O 'Bearer Token' informado no cabeçalho (header) 'Authorization' é inválido.\ **Solução**: Gere um novo token no método 'Autenticação' e o informe na requisição. 3. **Mensagem**: `Sessão expirada!`\ **Problema**: O token passou da validade máxima que é de 12 horas.\ **Solução**: Gere um novo token no método 'Autenticação' e o informe na requisição. 4. **Mensagem**: `Usuário não autenticado.`\ **Problema**: Ocorreu um problema na sessão do usuário usado na API.\ **Solução**: Entre em contato com o responsável pela criação do seu usuário e confiram o respectivo cadastro. 5. **Mensagem**: `Usuário não autorizado.`\ **Problema**: Ocorreu um problema na sessão do usuário usado na API.\ **Solução**: Entre em contato com o responsável pela criação do seu usuário e confiram o respectivo cadastro. 6. **Mensagem**: `Permissão negada: CAMINHO_DA_PERMISSAO`\ **Problema**: Seu usuário não tem a permissão no respectivo método da API.\ **Solução**: Entre em contato com o responsável pela criação do seu usuário e solicite liberar no respectivo perfil a permissão no método que está tentando usar. ### Outras mensagens Pode ocorrer outras mensagens, as quais geralmente serão relacionadas ao informe incorreto de dados na requisição. Nesse caso, a API retornará apontando qual o campo informado incorretamente. Além, pode acontecer também algum erro no servidor, o qual retornará um status com código iniciado em 5. Nesse caso, entre em contato conosco. {% hint style="info" %} No caso de retorno de uma mensagem não identificada, que não esteja devidamente documentada ou que não seja clara ao usuário, pedimos nos reportar no [Contato](/ajuda/contato) para que possamos avaliar e lhe ajudar conforme o necessário. {% endhint %} # Nomenclaturas Relação de nomenclaturas usadas na nossa API que podem não ser de conhecimento geral. No contexto do sistema **Siprov**, existem várias entidades principais que podem estar vinculadas, conforme o que existe no processo de uma pessoa jurídica usuária do sistema. Abaixo, descreveremos essas principais entidades para as quais será necessária ter uma compreensão mínima para um entendimento melhor da nossa API. ### Siprov É o nome do sistema com o qual essa API interage para consulta, inserção ou edição de dados. Esse sistema é desenvolvido pela empresa [Rumo Tecnologia](https://doc.siprov.com.br/ajuda/www.rumotecnologia.com.br). ### Cliente Siprov É a entidade principal do sistema, que é a pessoa jurídica que contrata o sistema para uso em sua operação. Essa entidade é sempre única em todo o sistema e estará ativa junto à Rumo Tecnologia conforme critérios administrativos, comerciais, contratuais e financeiros. ### Cliente (Associado) O consumidor padrão do negócio pode ser referenciado como **Associado** ou **Cliente** dependendo do contexto do respectivo [Cliente Siprov](#cliente-siprov). Podem-se adotar outros nomes também, considerando que essa entidade é apelidada no sistema. Esse cliente certamente vai estar vinculado a outra entidade, que é a [**Unidade**](#unidade-loja-ou-regional). ### Unidade (Loja ou Regional) Tal entidade, que também pode ser referenciada como **Loja**, é basicamente uma subdivisão do [Cliente Siprov](#cliente-siprov). Logo, essa entidade vai ser a filial ou regional da pessoa jurídica principal do sistema. ### Benefício (Contrato) O [Cliente](#associado) enquanto consumidor de algum serviço, vai ter vinculado em seu cadastro a entidade **Benefício**, que é um registro no sistema que podemos entender, de forma genérica, como um contrato. Nesse caso, o benefício terá informações e controles conforme o seu tipo. O tipo determina campos específicos e até módulos adicionais no sistema para prover a operação ideal do negócio diretamente relacionado. Os tipos podem ser de: * Assinatura * *Benefícios que demandam controle de saldo com cobrança recorrente.* * Assistência 24h * *Benefícios com a especifidade de controle de atendimento e acompanhamento imediato, como em serviços de assistência 24 horas, rastreamento, dentre outros.* * Consórcio * *Benefício específico para empresas de consórcio e que usam tabela de preço e grupos de consórcio.* * Diversos * *Benefício que contempla uma operação genérica de venda, contrato, financeiro, dentre outros, na empresa.* * Proteção Veicular * *Benefício específico para contratos que tem como item o veículo do cliente, com a opção de controle de eventos, rateios, etc.* * Saúde * *Benefício específico para empresas que operacionalizam serviços na área de saúde ou controlam marcação de consultas em rede credenciada (clínica ou médico).* ### Adesão (Cliente com Contrato) Nada mais é que a entidade conjunta de [Cliente](#associado) com seus respectivos [Benefícios](#beneficio). Chamamos dessa forma simplesmente por quê o cliente aderiu a algum benefício, então ele fez uma adesão. ### Plano (Produto) É o item que faz parte do benefício (contrato) do cliente (ou associado). Os planos (ou produtos) definem a cobertura ou vantagens que aquele benefício/cliente possuem, como uma cobertura contra incêndios, proteção residencial, plano de carro reserva, de assistência 24h com 200Km, clube de descontos, acesso a rede de clínicas médicas, etc. Cada benefício possui no mínimo um plano principal, o qual define algumas regras gerais no respectivo benefício. E de forma completar, pode-se ter planos adicionais que agregam mais serviços ou acessos para o contratante. Cada plano possui um valor e a soma desses vão ser justamente o valor da mensalidade. Esse valor também pode variar conforme existência de descontos/acréscimo, e pelo valor de rateio no caso de benefício do tipo "proteção veicular". ### Empresa É uma entidade que também é um cliente da pessoa jurídica contratante do sistema ([Cliente Siprov](#cliente-siprov)). Por exemplo, uma empresa no mercado que contrata um plano de saúde, vai ser cadastrada no sistema para nela ser listada seus beneficiários, que são os funcionários que usarão o benefício de plano de saúde. A empresa pagará uma mensalidade proporcional à quantidade de benefícios vendidos ou beneficiários atendidos. A saber, esses beneficiários são [associados](#associado) que ficam então, dentro da empresa. ### Documentação (Vistoria) É um processo que visa a coleta de dados e arquivos. Esse processo pode ter outros nomes conforme o cenário da empresa que o aplica. Em organizações de proteção veicular por exemplo, esse processo geralmente é chamado **Vistoria**. Essa entidade sempre se relaciona a alguma outra, como [benefício](#beneficio-contrato), [evento](#evento), dentre outros, para definir o que deverá ser recolhido de dados e arquivos, como dados de documentos, fotos, assinatura, etc. Por exemplo, ao acrescentar um novo benefício, o usuário poderá requerer que o cliente leia um contrato e o assine em seguida, além de confirmar alguns dados cadastrais e comerciais. Em alguns casos, pode querer que ele envie uma selfie. Outro exemplo: no cenário de um benefício do tipo "proteção veicular" é comum requisitar as fotos do veículo. ### Evento É o registro relacionado à intervenção feita em veículos ou outros equipamentos diretamente relacionados ao benefício. No negócio de proteção veicular, por exemplo, quando na ocorrência de um acidente ou na demanda da instalação de rastreador. ### Rede Credenciada Basicamente é o agrupamento das entidades Clínica, Médico ou Parceiro, que são prestadores de serviço. Clínicas e médicos são específicas para os benefícios de saúde. Já os parceiros são prestadores genéricos, nos quais podem constar os serviços ou descontos que oferecem. # Contato Dados de contato com a Rumo Tecnologia. Tem alguma dúvida sobre nossa **API**, do sistema Siprov ou de algum outro assunto relacionado? Entre em contato conosco: **Telefone:** [+55 31 3653-6582](tel://553136536582) **WhatsApp:** [(31) 97157-7575](https://web.whatsapp.com/send/?phone=5531971577575\&text\&type=phone_number) {% hint style="info" %} Ao acionar nossa central de atendimento, informe o assunto API/integração para ser devidamente direcionado ao atendimento especializado. {% endhint %} # Apresentação Apresentação resumida da API do Siprov. Com a API do Siprov, você pode desenvolver a integração da sua plataforma com o nosso sistema para prover as melhores soluções em prestação e gestão de serviços que contemplam a parte de controle de cadastros e contratos (adesões ou benefícios), financeiro, eventos, atendimento, assistência 24h, gestão de rastreamento, dentre outros. Antecipadamente, você deve estar ciente das questões relacionadas à liberação do seu usuário. Para isso, recomendamos a leitura dos [artigos introdutórios](/) desta documentação. E obviamente, e ter um prévio conhecimento técnico de trabalho com APIs. Logo, pode-se então trabalhar efetivamente com nossa API, seja em [ambiente de teste](/teste) numa aplicação para essa finalidade, como o [Postman](/teste), ou desenvolvendo diretamente em sua plataforma, local ou publicada online. Obviamente, deve-se adotar todas a boas práticas de segurança para minar quaisquer brechas ou falhas. # Autenticação Detalhamento de como deve ser feita a autenticação na API do Siprov. Primeiro passo para uso da API do Siprov é chamar o método [Autenticação (/ext/autenticacao)](/referencia-da-api/introducao-tecnica/autenticacao) para capturar sua chave de acesso. Você deve fazer um *POST* neste método passando o usuário e senha recebido como autenticação do tipo [Basic Auth](https://pt.stackoverflow.com/questions/254503/o-que-%C3%A9-basic-auth). #### Exemplo de requisição: {% code lineNumbers="true" %} ```shell curl --request POST \ --url https://acesso.siprov.com.br/siprov-api/ext/autenticacao \ --header 'accept: text/plain' \ --header 'authorization: Basic dGVzdGU6dGVzdGU=' ``` {% endcode %} Ao efetuar tal chamada, no retorno constará a chave (`authorizationToken`) que deverá ser usada na autenticação dos demais métodos. No caso, a autenticação então passa a ser do tipo Bearer Token. A chave gerada tem validade de 12 horas. Logo, esse método deve ser chamado recorrentemente para renovação da chave. Atente-se também que qualquer alteração efetuada na [configuração de acesso](/configuracao-do-acesso) implica obrigatoriamente na renovação da chave. Por fim, explicamos os demais campos que constaram no retorno desse método: * `codUsuario`: Código único do usuário autenticado na API; * `nomeUsuario`: Nome do respectivo usuário; * `codClienteSiprov`: Código único da empresa responsável pela base no sistema; * `nomeClienteSiprov`: Nome da respectivo empresa; * `permissaoLoja`: Lista de unidades (ou loja), que geralmente são filiais ou regionais, liberadas nesse usuário; * `codLoja`: Código único da unidade (loja); * `nome`: Nome da unidade (loja). * `plano`: Lista de planos liberados para esse usuário: * `codPlano`: Código único do plano; * `nome`: Nome do plano. # Introdução Técnica Introdução técnica da nossa API. A API do Siprov está implementada conforme padrão [REST](https://developer.mozilla.org/pt-BR/docs/Glossary/REST) e todos recursos são consumidos e utilizados por [URLs](https://pt.wikipedia.org/wiki/URL) (endereços) e transportados sobre [HTTPS](https://pt.wikipedia.org/wiki/Hyper_Text_Transfer_Protocol_Secure). Esses recursos implementam verbos HTTP de leitura e escrita, no caso, requisições *POST*, *GET* e *PUT* (não usamos *DELETE*). A saber, isso é equivalente às ações CRUD (create/criar | read/ler | update/atualizar | delete/remover). Toda resposta é gerada em formato JSON com [códigos de retorno padrão HTTP](https://developer.mozilla.org/pt-BR/docs/Web/HTTP/Status) (status code). Os endereços são compostos fixamente pelo endereço base , seguido dos sufixos que denominam o método a ser usado. A princípio, você deve usar seu usuário e senha para fazer uma autenticação *Basic Auth* no método [Autenticação (/ext/autenticacao)](broken://pages/ZmsemT8srdTwDpI5Yrvp) para gerar seu *Bearer Token*, o qual será usado para autenticar seu acesso em todos os demais endpoints que seguem descritos nos artigos a seguir. # Sobre API para integração ao sistema Siprov. Para testes, solicite usuário e senha à Rumo Tecnologia através do chat em nosso site ou por email. Para uso em produção, informe um email para o administrador da base criar seu usuário. A senha de acesso chegará no email informado. Use o método '/ext/autenticacao' para gerar o 'token' a ser usado nos demais métodos da API. A qualquer momento você pode resetar a senha desse usuário no endereço do sistema Siprov em . Endpoint:\ Qualquer dúvida, nosso atendimento está disponível de segunda à sexta de 9h às 18h pelo chat em nosso site ou por email. # Autenticação {% openapi src="/files/fy0T3OtfxZ7WjjJqbpvj" path="/ext/autenticacao" method="post" %} [rumotecnologia siprov api 1.57 resolved.json](https://3374107293-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FUxOfAamiGB15y1zYhmEk%2Fuploads%2Fdc0nr4ir9JxhyTU8eWxT%2Frumotecnologia%20siprov%20api%201.57%20resolved.json?alt=media) {% endopenapi %} # Empresa {% openapi src="/files/fy0T3OtfxZ7WjjJqbpvj" path="/ext/negociacao" method="get" %} [rumotecnologia siprov api 1.57 resolved.json](https://3374107293-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FUxOfAamiGB15y1zYhmEk%2Fuploads%2Fdc0nr4ir9JxhyTU8eWxT%2Frumotecnologia%20siprov%20api%201.57%20resolved.json?alt=media) {% endopenapi %} # Administração # Unidade (Loja) {% openapi src="" path="/ext/administracao/loja" method="get" %} {% endopenapi %} # Vendedor {% openapi src="" path="/ext/administracao/vendedor" method="get" %} {% endopenapi %} # Associado {% openapi src="" path="/ext/associado" method="get" %} {% endopenapi %} {% openapi src="" path="/ext/associado" method="post" %} {% endopenapi %} # Cartão de Crédito {% openapi src="" path="/ext/associado/{codPessoa}/cartaoCredito" method="get" %} {% endopenapi %} # Benefício {% openapi src="" path="/ext/beneficio" method="get" %} {% endopenapi %} {% openapi src="" path="/ext/beneficio" method="post" %} {% endopenapi %} # Cancelamento {% openapi src="" path="/ext/beneficio/{codBeneficio}/cancelar" method="put" %} {% endopenapi %} # Dependente {% openapi src="" path="/ext/beneficio/dependente" method="post" %} {% endopenapi %} # Tipo de Veículo {% openapi src="" path="/ext/beneficio/tipoVeiculo" method="get" %} {% endopenapi %} # Benefício Veicular {% openapi src="" path="/ext/beneficio/veicular" method="post" %} {% endopenapi %} # Validação {% openapi src="" path="/ext/beneficio/validacao" method="post" %} {% endopenapi %} # Vencimento {% openapi src="" path="/ext/beneficio/vencimento" method="get" %} {% endopenapi %} # Itens {% openapi src="" path="/ext/beneficio/{codBeneficio}/itens" method="get" %} {% endopenapi %} # Dependentes {% openapi src="" path="/ext/beneficio/{codBeneficio}/dependentes" method="get" %} {% endopenapi %} # Documentação/Vistoria {% openapi src="/files/fy0T3OtfxZ7WjjJqbpvj" path="/ext/vistoria" method="post" %} [rumotecnologia siprov api 1.57 resolved.json](https://3374107293-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FUxOfAamiGB15y1zYhmEk%2Fuploads%2Fdc0nr4ir9JxhyTU8eWxT%2Frumotecnologia%20siprov%20api%201.57%20resolved.json?alt=media) {% endopenapi %} {% openapi src="/files/fy0T3OtfxZ7WjjJqbpvj" path="/ext/vistoria/{codVistoria}" method="get" %} [rumotecnologia siprov api 1.57 resolved.json](https://3374107293-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FUxOfAamiGB15y1zYhmEk%2Fuploads%2Fdc0nr4ir9JxhyTU8eWxT%2Frumotecnologia%20siprov%20api%201.57%20resolved.json?alt=media) {% endopenapi %} # Tipos {% openapi src="/files/fy0T3OtfxZ7WjjJqbpvj" path="/ext/vistoria/tipos" method="get" %} [rumotecnologia siprov api 1.57 resolved.json](https://3374107293-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FUxOfAamiGB15y1zYhmEk%2Fuploads%2Fdc0nr4ir9JxhyTU8eWxT%2Frumotecnologia%20siprov%20api%201.57%20resolved.json?alt=media) {% endopenapi %} # Anexo {% openapi src="/files/fy0T3OtfxZ7WjjJqbpvj" path="/ext/vistoria/{codVistoria}/anexo" method="put" %} [rumotecnologia siprov api 1.57 resolved.json](https://3374107293-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FUxOfAamiGB15y1zYhmEk%2Fuploads%2Fdc0nr4ir9JxhyTU8eWxT%2Frumotecnologia%20siprov%20api%201.57%20resolved.json?alt=media) {% endopenapi %} # Documento {% openapi src="/files/fy0T3OtfxZ7WjjJqbpvj" path="/ext/vistoria/{codVistoria}/documento/{tipo}" method="put" %} [rumotecnologia siprov api 1.57 resolved.json](https://3374107293-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FUxOfAamiGB15y1zYhmEk%2Fuploads%2Fdc0nr4ir9JxhyTU8eWxT%2Frumotecnologia%20siprov%20api%201.57%20resolved.json?alt=media) {% endopenapi %} # Foto {% openapi src="/files/fy0T3OtfxZ7WjjJqbpvj" path="/ext/vistoria/{codVistoria}/foto/{codTipo}" method="put" %} [rumotecnologia siprov api 1.57 resolved.json](https://3374107293-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FUxOfAamiGB15y1zYhmEk%2Fuploads%2Fdc0nr4ir9JxhyTU8eWxT%2Frumotecnologia%20siprov%20api%201.57%20resolved.json?alt=media) {% endopenapi %} # Financeiro # Cartão de Crédito {% openapi src="" path="/ext/financeiro/cartaoCredito" method="post" %} {% endopenapi %} # Forma de Pagamento {% openapi src="" path="/ext/financeiro/formaPagamento" method="get" %} {% endopenapi %} # Tipo de Liquidação {% openapi src="" path="/ext/financeiro/tipoLiquidacao" method="get" %} {% endopenapi %} # Tipo de Título {% openapi src="" path="/ext/financeiro/tipoTitulo" method="get" %} {% endopenapi %} # Título {% openapi src="" path="/ext/financeiro/titulo" method="get" %} {% endopenapi %} {% openapi src="" path="/ext/financeiro/titulo" method="post" %} {% endopenapi %} {% openapi src="" path="/ext/financeiro/titulo/{codTitulo}" method="get" %} {% endopenapi %} # Boleto {% openapi src="" path="/ext/financeiro/titulo/boleto" method="get" %} {% endopenapi %} {% openapi src="" path="/ext/financeiro/titulo/{codTitulo}/boleto" method="get" %} {% endopenapi %} {% openapi src="" path="/ext/financeiro/titulo/{codTitulo}/boleto" method="post" %} {% endopenapi %} # Liquidar {% openapi src="" path="/ext/financeiro/titulo/liquidar" method="post" %} {% endopenapi %} # Pagar {% openapi src="" path="/ext/financeiro/titulo/pagar" method="post" %} {% endopenapi %} # Evento {% openapi src="/files/fy0T3OtfxZ7WjjJqbpvj" path="/ext/evento" method="get" %} [rumotecnologia siprov api 1.57 resolved.json](https://3374107293-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FUxOfAamiGB15y1zYhmEk%2Fuploads%2Fdc0nr4ir9JxhyTU8eWxT%2Frumotecnologia%20siprov%20api%201.57%20resolved.json?alt=media) {% endopenapi %} {% openapi src="/files/fy0T3OtfxZ7WjjJqbpvj" path="/ext/evento/{codEvento}" method="get" %} [rumotecnologia siprov api 1.57 resolved.json](https://3374107293-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FUxOfAamiGB15y1zYhmEk%2Fuploads%2Fdc0nr4ir9JxhyTU8eWxT%2Frumotecnologia%20siprov%20api%201.57%20resolved.json?alt=media) {% endopenapi %} # Orçamento {% openapi src="/files/fy0T3OtfxZ7WjjJqbpvj" path="/ext/evento/{codEvento}/orcamentos" method="get" %} [rumotecnologia siprov api 1.57 resolved.json](https://3374107293-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FUxOfAamiGB15y1zYhmEk%2Fuploads%2Fdc0nr4ir9JxhyTU8eWxT%2Frumotecnologia%20siprov%20api%201.57%20resolved.json?alt=media) {% endopenapi %} {% openapi src="/files/fy0T3OtfxZ7WjjJqbpvj" path="/ext/evento/orcamento" method="post" %} [rumotecnologia siprov api 1.57 resolved.json](https://3374107293-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FUxOfAamiGB15y1zYhmEk%2Fuploads%2Fdc0nr4ir9JxhyTU8eWxT%2Frumotecnologia%20siprov%20api%201.57%20resolved.json?alt=media) {% endopenapi %} # Situação de Evento {% openapi src="/files/fy0T3OtfxZ7WjjJqbpvj" path="/ext/evento/situacaoEvento" method="get" %} [rumotecnologia siprov api 1.57 resolved.json](https://3374107293-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FUxOfAamiGB15y1zYhmEk%2Fuploads%2Fdc0nr4ir9JxhyTU8eWxT%2Frumotecnologia%20siprov%20api%201.57%20resolved.json?alt=media) {% endopenapi %} # Tipo de Evento {% openapi src="/files/fy0T3OtfxZ7WjjJqbpvj" path="/ext/evento/tipoEvento" method="get" %} [rumotecnologia siprov api 1.57 resolved.json](https://3374107293-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FUxOfAamiGB15y1zYhmEk%2Fuploads%2Fdc0nr4ir9JxhyTU8eWxT%2Frumotecnologia%20siprov%20api%201.57%20resolved.json?alt=media) {% endopenapi %} # Rede Credenciada # Clínica {% openapi src="/files/fy0T3OtfxZ7WjjJqbpvj" path="/ext/rede/clinica" method="get" %} [rumotecnologia siprov api 1.57 resolved.json](https://3374107293-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FUxOfAamiGB15y1zYhmEk%2Fuploads%2Fdc0nr4ir9JxhyTU8eWxT%2Frumotecnologia%20siprov%20api%201.57%20resolved.json?alt=media) {% endopenapi %} {% openapi src="/files/fy0T3OtfxZ7WjjJqbpvj" path="/ext/rede/clinica/{id}" method="get" %} [rumotecnologia siprov api 1.57 resolved.json](https://3374107293-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FUxOfAamiGB15y1zYhmEk%2Fuploads%2Fdc0nr4ir9JxhyTU8eWxT%2Frumotecnologia%20siprov%20api%201.57%20resolved.json?alt=media) {% endopenapi %} # Especialidade {% openapi src="/files/fy0T3OtfxZ7WjjJqbpvj" path="/ext/rede/especialidade" method="get" %} [rumotecnologia siprov api 1.57 resolved.json](https://3374107293-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FUxOfAamiGB15y1zYhmEk%2Fuploads%2Fdc0nr4ir9JxhyTU8eWxT%2Frumotecnologia%20siprov%20api%201.57%20resolved.json?alt=media) {% endopenapi %} # Exame {% openapi src="/files/fy0T3OtfxZ7WjjJqbpvj" path="/ext/rede/exame" method="get" %} [rumotecnologia siprov api 1.57 resolved.json](https://3374107293-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FUxOfAamiGB15y1zYhmEk%2Fuploads%2Fdc0nr4ir9JxhyTU8eWxT%2Frumotecnologia%20siprov%20api%201.57%20resolved.json?alt=media) {% endopenapi %} # Médico {% openapi src="/files/fy0T3OtfxZ7WjjJqbpvj" path="/ext/rede/medico" method="get" %} [rumotecnologia siprov api 1.57 resolved.json](https://3374107293-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FUxOfAamiGB15y1zYhmEk%2Fuploads%2Fdc0nr4ir9JxhyTU8eWxT%2Frumotecnologia%20siprov%20api%201.57%20resolved.json?alt=media) {% endopenapi %} {% openapi src="/files/fy0T3OtfxZ7WjjJqbpvj" path="/ext/rede/medico/{id}" method="get" %} [rumotecnologia siprov api 1.57 resolved.json](https://3374107293-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FUxOfAamiGB15y1zYhmEk%2Fuploads%2Fdc0nr4ir9JxhyTU8eWxT%2Frumotecnologia%20siprov%20api%201.57%20resolved.json?alt=media) {% endopenapi %} # Parceiro {% openapi src="/files/fy0T3OtfxZ7WjjJqbpvj" path="/ext/rede/parceiro" method="get" %} [rumotecnologia siprov api 1.57 resolved.json](https://3374107293-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FUxOfAamiGB15y1zYhmEk%2Fuploads%2Fdc0nr4ir9JxhyTU8eWxT%2Frumotecnologia%20siprov%20api%201.57%20resolved.json?alt=media) {% endopenapi %} # Servico {% openapi src="/files/fy0T3OtfxZ7WjjJqbpvj" path="/ext/rede/parceiro/servico" method="get" %} [rumotecnologia siprov api 1.57 resolved.json](https://3374107293-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FUxOfAamiGB15y1zYhmEk%2Fuploads%2Fdc0nr4ir9JxhyTU8eWxT%2Frumotecnologia%20siprov%20api%201.57%20resolved.json?alt=media) {% endopenapi %} # Tipo {% openapi src="/files/fy0T3OtfxZ7WjjJqbpvj" path="/ext/rede/parceiro/tipo" method="get" %} [rumotecnologia siprov api 1.57 resolved.json](https://3374107293-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FUxOfAamiGB15y1zYhmEk%2Fuploads%2Fdc0nr4ir9JxhyTU8eWxT%2Frumotecnologia%20siprov%20api%201.57%20resolved.json?alt=media) {% endopenapi %} # Região de Atendimento {% openapi src="/files/fy0T3OtfxZ7WjjJqbpvj" path="/ext/rede/regiao" method="get" %} [rumotecnologia siprov api 1.57 resolved.json](https://3374107293-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FUxOfAamiGB15y1zYhmEk%2Fuploads%2Fdc0nr4ir9JxhyTU8eWxT%2Frumotecnologia%20siprov%20api%201.57%20resolved.json?alt=media) {% endopenapi %} # Saúde # Marcação de Consulta {% openapi src="/files/fy0T3OtfxZ7WjjJqbpvj" path="/ext/saude/marcacao" method="post" %} [rumotecnologia siprov api 1.57 resolved.json](https://3374107293-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FUxOfAamiGB15y1zYhmEk%2Fuploads%2Fdc0nr4ir9JxhyTU8eWxT%2Frumotecnologia%20siprov%20api%201.57%20resolved.json?alt=media) {% endopenapi %} {% openapi src="/files/fy0T3OtfxZ7WjjJqbpvj" path="/ext/saude/marcacao/{codConsulta}" method="get" %} [rumotecnologia siprov api 1.57 resolved.json](https://3374107293-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FUxOfAamiGB15y1zYhmEk%2Fuploads%2Fdc0nr4ir9JxhyTU8eWxT%2Frumotecnologia%20siprov%20api%201.57%20resolved.json?alt=media) {% endopenapi %} # CRM # Lead {% openapi src="" path="/ext/crm/lead" method="get" %} {% endopenapi %} {% openapi src="" path="/ext/crm/lead" method="post" %} {% endopenapi %} # Integração Especial # Univers {% openapi src="/files/fy0T3OtfxZ7WjjJqbpvj" path="/ext/integracao/univers" method="get" %} [rumotecnologia siprov api 1.57 resolved.json](https://3374107293-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FUxOfAamiGB15y1zYhmEk%2Fuploads%2Fdc0nr4ir9JxhyTU8eWxT%2Frumotecnologia%20siprov%20api%201.57%20resolved.json?alt=media) {% endopenapi %} # Araújo # Empresas {% openapi src="/files/fy0T3OtfxZ7WjjJqbpvj" path="/ext/integracao/araujo/empresas/{matricula}" method="get" %} [rumotecnologia siprov api 1.57 resolved.json](https://3374107293-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FUxOfAamiGB15y1zYhmEk%2Fuploads%2Fdc0nr4ir9JxhyTU8eWxT%2Frumotecnologia%20siprov%20api%201.57%20resolved.json?alt=media) {% endopenapi %} # Introdução Introdução técnica sobre os gatilhos. **Documentação dos gatilhos disparados pelo sistema Siprov.** O conteúdo (payload) da requisição é disparado em formato JSON via método POST com o cabeçalho (header) *Content-Type = application/json*. O **Siprov** aceitará como sucesso qualquer status com código na faixa *200-204*. Os demais serão considerados erro. O payload conterá apenas os dados básicos. Detalhes devem ser obtidos via API externa.\ Consulte nossa API no link de documentação abaixo. Serão feitas até 5 tentativas de envio de forma automática. Além disso, o reenvio deve ser feito manualmente. Os gatilhos deverão ser cadastrados dentro do Siprov em *'Ferramenta > Sistema > Gatilhos'*.\ Já o status de envio pode ser acompanhado em *'Relatório > Log > Envio de Gatilho'*. Nessa tela também existe a opção de acionar o reenvio em caso de falha da recepção pela destinatário. Para testar, você pode usar a plataforma [Beeceptor](https://beeceptor.com/) ou outro receptor de webhooks. # Referência # Acionamento {% openapi src="/files/mVrY0cm03gbGfnFUBZCW" path="/acionamento" method="post" %} [rumotecnologia siprov webhooks 1.1 resolved.json](https://3374107293-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FUxOfAamiGB15y1zYhmEk%2Fuploads%2FygJZu9zkd6MJXIpbjU6A%2Frumotecnologia%20siprov%20webhooks%201.1%20resolved.json?alt=media) {% endopenapi %} # Benefício {% openapi src="/files/mVrY0cm03gbGfnFUBZCW" path="/beneficio" method="post" %} [rumotecnologia siprov webhooks 1.1 resolved.json](https://3374107293-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FUxOfAamiGB15y1zYhmEk%2Fuploads%2FygJZu9zkd6MJXIpbjU6A%2Frumotecnologia%20siprov%20webhooks%201.1%20resolved.json?alt=media) {% endopenapi %} # Marcação de Consulta {% openapi src="/files/mVrY0cm03gbGfnFUBZCW" path="/consulta" method="post" %} [rumotecnologia siprov webhooks 1.1 resolved.json](https://3374107293-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FUxOfAamiGB15y1zYhmEk%2Fuploads%2FygJZu9zkd6MJXIpbjU6A%2Frumotecnologia%20siprov%20webhooks%201.1%20resolved.json?alt=media) {% endopenapi %} # Negócio de CRM {% openapi src="/files/mVrY0cm03gbGfnFUBZCW" path="/negocio" method="post" %} [rumotecnologia siprov webhooks 1.1 resolved.json](https://3374107293-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FUxOfAamiGB15y1zYhmEk%2Fuploads%2FygJZu9zkd6MJXIpbjU6A%2Frumotecnologia%20siprov%20webhooks%201.1%20resolved.json?alt=media) {% endopenapi %} # Evento {% openapi src="/files/mVrY0cm03gbGfnFUBZCW" path="/evento" method="post" %} [rumotecnologia siprov webhooks 1.1 resolved.json](https://3374107293-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FUxOfAamiGB15y1zYhmEk%2Fuploads%2FygJZu9zkd6MJXIpbjU6A%2Frumotecnologia%20siprov%20webhooks%201.1%20resolved.json?alt=media) {% endopenapi %} # Help Desk {% openapi src="/files/mVrY0cm03gbGfnFUBZCW" path="/helpDesk" method="post" %} [rumotecnologia siprov webhooks 1.1 resolved.json](https://3374107293-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FUxOfAamiGB15y1zYhmEk%2Fuploads%2FygJZu9zkd6MJXIpbjU6A%2Frumotecnologia%20siprov%20webhooks%201.1%20resolved.json?alt=media) {% endopenapi %} # Rastreador {% openapi src="/files/mVrY0cm03gbGfnFUBZCW" path="/rastreador" method="post" %} [rumotecnologia siprov webhooks 1.1 resolved.json](https://3374107293-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FUxOfAamiGB15y1zYhmEk%2Fuploads%2FygJZu9zkd6MJXIpbjU6A%2Frumotecnologia%20siprov%20webhooks%201.1%20resolved.json?alt=media) {% endopenapi %} # Título {% openapi src="/files/mVrY0cm03gbGfnFUBZCW" path="/titulo" method="post" %} [rumotecnologia siprov webhooks 1.1 resolved.json](https://3374107293-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FUxOfAamiGB15y1zYhmEk%2Fuploads%2FygJZu9zkd6MJXIpbjU6A%2Frumotecnologia%20siprov%20webhooks%201.1%20resolved.json?alt=media) {% endopenapi %} # Documentação/Vistoria {% openapi src="/files/mVrY0cm03gbGfnFUBZCW" path="/vistoria" method="post" %} [rumotecnologia siprov webhooks 1.1 resolved.json](https://3374107293-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FUxOfAamiGB15y1zYhmEk%2Fuploads%2FygJZu9zkd6MJXIpbjU6A%2Frumotecnologia%20siprov%20webhooks%201.1%20resolved.json?alt=media) {% endopenapi %}