Base de Conhecimento de Gestão Comercial de Saneamento

Essa página está em modo somente de leitura. Você pode visualizar a fonte, mas não alterá-la. Informe-se com o administrador do Wiki, caso você ache que isso está incorreto.

<p> <a href="/lib/exe/detail.php?id=integracoes%3Aweb-services-gerar-cnd&media=ajuda:logo-gsan3.png" class="media" title="ajuda:logo-gsan3.png"><img src="/lib/exe/fetch.php?w=90&tok=2a27bf&media=ajuda:logo-gsan3.png" class="media" alt="" width="90" /></a> </p> <h1>WebService Gerar Certidão Negativa</h1> <div class="level1"> <p> &lt;columns> O WebService recebe apenas requisições do tipo <b>GET</b>, e os parâmetros são passados via <b>Query Parameter</b>. </p> <p> Ele espera os seguintes Parâmetros: </p> <ol> <li class="level1"> key, <em>String</em> contendo a chave de autenticação da empresa.</li> <li class="level1"> matricula, <em>String</em> parâmetro opcional, contendo a matrícula do imóvel que se pretende pesquisar.</li> <li class="level1"> email, <em>String</em> parâmetro opcional; caso seja informado o sistema envia a certidão para o e-mail informado.</li> <li class="level1"> cpfCnpf, <em>String</em> parâmetro opcional, contendo o cpf ou cnpj do cliente que se pretende pesquisar. </li> <li class="level1"> É obrigatorio informar matrícula ou cpf/cnpj.</li> </ol> <p> &lt;/columns> </p> <pre class="code">\\ ===== Exemplo de Requisição para o Sistema ===== </pre><p> </p> <p> Com as seguintes informações: </p> <span class='np_break'> </span> <div class="table"><table class="inline"> <tr class="row0"> <td class="col0">IP</td><td class="col1">192.168.64.111</td> </tr> <tr class="row1"> <td class="col0">Chave de autenticação</td><td class="col1">aBC123DEF</td> </tr> <tr class="row2"> <td class="col0">Matrícula</td><td class="col1">5136024</td> </tr> <tr class="row3"> <td class="col0">E-mail </td><td class="col1">teste@teste.com</td> </tr> <tr class="row4"> <td class="col0">cpfCnpj </td><td class="col1"> 12345678985 </td> </tr> </table> <span class='np_break'> </span> </div> <p> <br/> </p> </div> <h2>A Requisição Seria</h2> <div class="level2"> <p> certidão do imóvel <a href="http://192.168.64.111:8080/gsan/certidaoNegativaDebitos?key=aBC123DEF&matricula=5136024&email=teste@teste.com" class="urlextern" title="http://192.168.64.111:8080/gsan/certidaoNegativaDebitos?key=aBC123DEF&matricula=5136024&email=teste@teste.com" rel="nofollow">http://192.168.64.111:8080/gsan/certidaoNegativaDebitos?key=aBC123DEF&matricula=5136024&email=teste@teste.com</a> </p> <p> ou </p> <p> certidão do cliente <a href="http://192.168.64.111:8080/gsan/certidaoNegativaDebitos?key=aBC123DEF&cpfCnpj=15685212345&email=teste@teste.com" class="urlextern" title="http://192.168.64.111:8080/gsan/certidaoNegativaDebitos?key=aBC123DEF&cpfCnpj=15685212345&email=teste@teste.com" rel="nofollow">http://192.168.64.111:8080/gsan/certidaoNegativaDebitos?key=aBC123DEF&cpfCnpj=15685212345&email=teste@teste.com</a> </p> <p> <br/> </p> </div> <h2>Retorno em Caso de Sucesso</h2> <div class="level2"> <p> <b>Download do arquivo PDF</b> </p> <p> <br/> </p> </div> <h2>Retorno em Caso de Erro</h2> <div class="level2"> <pre class="code javascript"><span class="br0">{</span> "error"<span class="sy0">:</span> <span class="br0">(</span>Integer<span class="br0">)</span> Código de erro da requisição<span class="sy0">,</span> "msg"<span class="sy0">:</span> <span class="br0">(</span><span class="kw4">String</span><span class="br0">)</span> Mensagem indicando o que houve<span class="sy0">,</span> ou vazio em caso de erro <span class="nu0">500</span><span class="sy0">,</span> "qtd"<span class="sy0">:</span> <span class="br0">(</span>Integer<span class="br0">)</span> sempre valor <span class="nu0">0</span> <span class="br0">}</span>     </pre><p> </p> <p> <b>Exemplo</b>: <br/> </p> <p> &lt;WRAP center round box 100%> <img src="/lib/exe/fetch.php?media=integracoes:gerar_certidao_negativa_json_1.jpg" class="mediacenter" alt="" /> &lt;/WRAP> </p> <pre class="code">\\ ===== Possíveis Códigos de Retorno ===== </pre><p> </p> <p> |Código|Mensagem| </p> <span class='np_break'> </span> <div class="table"><table class="inline"> <tr class="row0"> <td class="col0">400</td><td class="col1">"parâmetros inválidos"</td> </tr> <tr class="row1"> <td class="col0">401</td><td class="col1">"chave inválida"</td> </tr> <tr class="row2"> <td class="col0">404</td><td class="col1">"A consulta não trouxe resultados"</td> </tr> <tr class="row3"> <td class="col0">500</td><td class="col1">“”</td> </tr> </table> <span class='np_break'> </span> </div> <p> <br/> </p> <p> Clique <b><a href="/doku.php?id=treinamentos:integracoes" class="wikilink1" title="treinamentos:integracoes">AQUI</a></b> para acessar outros serviços com os detalhes técnicos das integrações. </p> </div>