O que é
Sobre a requisição:
Método: POST
Endereço: URL Base + /api/maestro/prefeitura-sp/certidao-dados-cadastrais-imovel-iptu
...
Include Page | ||||
---|---|---|---|---|
|
Parâmetros do header
Nome | Tipo | Obrigatório? | Descrição |
---|---|---|---|
Authorization | String | Sim | Chave de API gerada no cadastro no Plexi, prefixada com |
Callback | String | Não | URL para onde o resultado da requisição será enviado via HTTP POST. |
Parâmetros do body
Nome | Tipo | Obrigatório? | Descrição |
---|---|---|---|
cpfCnpj | string | Sim | CPF ou CNPJ de login |
senha | string | Sim | Senha para login |
sql | string | Sim | Número do cadastro do imóvel (também chamado de número do contribuinte ou SQL) |
anoExercicio | string | Sim | Ano de exercício do IPTU |
Estrutura da resposta
Status | Significado | Descrição | Informações retornadas |
---|---|---|---|
201 | Created | Solicitação criada | Campo requestId, com o ID da requisição criada. |
422 | Unprocessable Entity | A solicitação contém erro | Em quais campos houve erro. |
Exemplos de retornos quando você faz a requisição:
Status 201
Include Page | ||||
---|---|---|---|---|
|
...
Include Page | ||||
---|---|---|---|---|
|
Exemplos de retornos do resultado da pesquisa
Valores possíveis do campo “status“
Status | Significado |
---|---|
cadastrado | Imóvel encontrado |
erro | Erro ao buscar informações, seja por SQL inválido ou outro dado incorreto |
Respostas com registro encontrado
...
Code Block | ||
---|---|---|
| ||
{
"status": "erro",
"mensagem": "Número do cadastro do imóvel inválido",
"pdf": "JVBERi0xLjQKMSAwIG9iago8..."
} |
Code Block | ||
---|---|---|
| ||
{
"status": "erro",
"mensagem": "Não é possível gerar o documento. Verifique o Número do Cadastro do Imóvel.",
"pdf": "JVBERi0xLjQKMSAwIG9iago8..."
} |
...