Diferenças

Aqui você vê as diferenças entre duas revisões dessa página.

--- integracoes:web-services-emitir-extrato-parcelamento-avista-codigo-barras [29/09/2025 14:37] – criada jefferson.araujo
+++ integracoes:web-services-emitir-extrato-parcelamento-avista-codigo-barras [29/09/2025 18:43] (atual) – ajuste jefferson.araujo
@@ Linha 1: / Linha 1: @@
-{{ajuda:logo-gsan3.png?90|}}
+{{:ajuda:logo-gsan3.png?90}}
-====== Web Service Emitir Extrado de Parcelamento à vista Código de Barras ======
+====== Web Service Emitir Extrato de Parcelamento à vista Código de Barras(Municipal) ======
-<columns>
+<columns> O WebService recebe apenas requisições do tipo **GET**, e os parâmetros são passados via Query Parameter. Precisa autenticar passando uma key via header. Presente apenas na versão municipal. </columns>
-O WebService recebe apenas requisições do tipo **GET**, e os parâmetros são passados via Query Parameter.
-</columns>
-<columns>
+<columns> São esperados os seguintes parâmetros:
-São esperados os seguintes parâmetros:
-|**Parâmetro** | **Valor** | **Tipo** |
+|**Parâmetro** |**Valor** |**Tipo** |
-|matricula| Matrícula do Imóvel|String|
+|matricula|Matrícula do Imóvel|String|
-|resolucaoDiretoria| Resolução de diretoria (opcional)|String|
+|resolucaoDiretoria|Resolução de diretoria. Opcional, se não informado usará um default.|String|
-</columns>
+<columns> É esperado o seguinte Header:
+|**Header** |**Valor** |**Tipo** |
+|key|Chave de autenticação|String|
 == Exemplo de Requisição ==
 <code>
 https://<URL_GSAN>:<porta>/gsan/chatbot/emitirExtratoParcelamentoAVistaCodigoBarras?matricula=99999&resolucaoDiretoria=99
 </code>
 == Retornos ==
-<columns>
- Com sucesso:
+<columns> Com sucesso:
 <code javascript>
@@ Linha 33: / Linha 35: @@
     }
 }
-</code>
+</code>
 Com erro:
@@ Linha 47: / Linha 49: @@
     }
 }
 </code>
+Com erro de autenticação:
+<code javascript>
+{"error":{"detailMessage":"Chave não autorizada"}}
+</code>
 </columns>
 == Possíveis Códigos de Retorno ==
-| **Código** | **Mensagem**
+|**Código** | |
-|200 | "OK"|
+|200|"OK"|
-|500 | "Internal Server Error"|
+|401|"Unauthorized"|
+|500|"Internal Server Error"|