Skip to content

Changes

Page history
Update End Points authored by Augusto Barbosa Layber's avatar Augusto Barbosa Layber
Show whitespace changes
Inline Side-by-side
End-Points.md
View page @ d4ee5c16
# Lista de Endpoints # Documentação da API de Pagamento de Débitos de Veículo Integração com Internet Banking
Aqui estão os principais endpoints da nossa API: ## Endpoints
- 'GET guia-pagamento/internet-banking/v1/verificar-debitos' - Retorna todos os tipos de débitos que o veículo possui. ### 1. Verificar Débitos
- 'GET guia-pagamento/internet-banking/v1/obter-tipo-debito-detalhado' - Retorna os débitos que faz parte o tipo de débito selecionado. - **Endpoint**: `GET /guia-pagamento/internet-banking/v1/verificar-debitos/{placa}/{renavam}/{documentoProprietario}`
- 'GET guia-pagamento/internet-banking/v1/obter-todos-debitos-detalhados' - Retorna todos os débitos em aberto. - **Descrição**: Retorna todos os tipos de débitos que o veículo possui.
- 'PUT guia-pagamento/internet-banking/v1/gerar-guia' - Gera a guia de pagamento de um tipo de débito. - **Parâmetros**:
- 'GET guia-pagamento/internet-banking/v1/obter-veiculo' - Retorna dados do veículo consultado. - `placa`(string, obrigatório): Identificação do veículo.
- `renavam`(string, obrigatório): Registro Nacional de Veículos Automotores.
# Detalhes do Endpoint: 'v1/verificar-debitos' - `documentoProprietario`(string, obrigatório): Documento do proprietário do veículo.
- **Resposta**
### Descrição - Array<Enum<string>>
Retorna a lista dos tipos de débitos devidos do veículo consultado. Está lista pode conter um ou mais registros, pois para cada tipo de débito devido existem os débitos que são obrigatórios para a quitação dos débitos.
### Parâmetros
- `placa` (obrigatório)
- Tipo: `string`
- `renavam` (obrigatório)
- Tipo: `string`
- `documentoProprietario` (obrigatório)
- Tipo: `string`
### Exemplo de Requisição
```bash
curl -X 'GET' \
'https://api.detranveiculo.hom.es.gov.br/guia-pagamento/internet-banking/v1/verificar-debitos/{placa}/{renavam}/{documentoProprietario}' \
-H 'accept: text/plain' \
-H 'Authorization: Bearer SEU_TOKEN_DE_API'
```
### Resposta
- DebitoDevido (Array<Enum>): Tipo do débito devido, neste caso, "IPVAExercicio" e "LicenciamentoExercicio".
- Values: [IPVAExercicio, IPVAAnterior, DPVATExercicio, DPVATAnterior, LicenciamentoExercicio, LicenciamentoAnterior, Multa] - Values: [IPVAExercicio, IPVAAnterior, DPVATExercicio, DPVATAnterior, LicenciamentoExercicio, LicenciamentoAnterior, Multa]
- **Json Resposta**
```json ```json
[ [
"IPVAExercicio", "IPVAExercicio",
"LicenciamentoExercicio" "LicenciamentoExercicio"
] ]
``` ```
### 2. Obter Tipo de Débito Detalhado
### Tratamento de Erro - **Endpoint**: `GET /guia-pagamento/internet-banking/v1/obter-tipo-debito-detalhado`
```markdown - **Descrição**: Retorna os débitos que fazem parte do tipo de débito selecionado.
# Tratamento de Erros - **Parâmetros**:
- `placa`(string, obrigatório)
Nossa API retorna códigos de status HTTP para indicar o sucesso ou falha de uma requisição. - `renavam`(string, obrigatório)
- `documentoProprietario`(string, obrigatório)
- `401 Unauthorized` - Falha na autenticação. - `debitoDevido`(string, obrigatório): Tipo de débito a ser detalhado.
- `403 Forbidden` - Sem permissão - **Resposta**
- `404 Not Found` - O recurso solicitado não foi encontrado. - `descricao`(string): Descrição do débito principal.
- `422 Unprocessable Entity` - Erro de validação. - `exercicio`(int): Exercício do pagamento do débito principal.
- `500 Internal Server Error` - Erro no servidor. - `debitoDevido`(string): Tipo de débito que foi detalhado
- `502 Bad Gateway` - Erro de proxy - `debitos`(array): A lista de débito que compoem o tipo de débito que foi detalhando.
- `503 Service Unavailable` - Servidor não está pronto para requisição - `guid`(int): Identificação do débito.
``` - `descricao`(string): Descrição do débito.
- `dataVencimento`(DateTime): Data de vencimento do débito.
# Detalhes do Endpoint: 'v1/obter-tipo-debito-detalhado' - `valor`(decimal): Valor do débito.
- `pagamentoObrigatorio`(boolean): Indica se é obrigatório o pagamento do débito para o tipo selecionado.
### Descrição
Retorna a lista de débitos de um tipo especifico.
### Parâmetros
- `placa` (obrigatório)
- Tipo: `string`
- `renavam` (obrigatório)
- Tipo: `string`
- `documentoProprietario` (obrigatório)
- Tipo: `string`
- `debitoDevido` (obrigatório)
- Tipo: `Enum<string>`
- Values: [IPVAExercicio, IPVAAnterior, DPVATExercicio, DPVATAnterior, LicenciamentoExercicio, LicenciamentoAnterior, Multa]
- Observação: Deve-se informar apenas um tipo de débito devido.
### Requisição
```bash
curl -X 'GET' \
'https://api.detranveiculo.hom.es.gov.br/guia-pagamento/internet-banking/v1/obter-tipo-debito-detalhado/{placa}/{renavam}/{documentoProprietario}?debitoDevido=IPVAExercicio' \
-H 'accept: text/plain' \
-H 'Authorization: Bearer SEU_TOKEN_DE_API'
```
### Resposta
- Descricao (string): Uma breve descrição do débito devido.
- Exercicio (integer): Ano do exercício referente ao débito.
- DebitoDevido (Enum): Tipo do débito devido, neste caso, "IPVAExercicio".
- Values: [IPVAExercicio, IPVAAnterior, DPVATExercicio, DPVATAnterior, LicenciamentoExercicio, LicenciamentoAnterior, Multa]
- Debitos (array): Lista de débitos associados.
- Guid (integer): Identificador único do débito.
- Descricao (string): Descrição do débito.
- DataVencimento (string, formato datetime): Data de vencimento do débito.
- Valor (decimal): Valor do débito.
- PagamentoObrigatorio (boolean): Indica se o pagamento é obrigatório.
```json ```json
{ {
"descricao": "string", "descricao": "string",
...@@ -108,57 +53,26 @@ curl -X 'GET' \ ...@@ -108,57 +53,26 @@ curl -X 'GET' \
] ]
} }
``` ```
### 3. Obter Todos Tipos de Débitos Detalhados
### Tratamento de Erro - **Endpoint**: `GET /guia-pagamento/internet-banking/v1/obter-todos-tipos-debitos-detalhados`
```markdown - **Descrição**: Retorna todos os tipos de débitos e o débitos que fazem parte do tipo de débito.
# Tratamento de Erros - **Parâmetros**:
- `placa`(string, obrigatório)
Nossa API retorna códigos de status HTTP para indicar o sucesso ou falha de uma requisição. - `renavam`(string, obrigatório)
- `documentoProprietario`(string, obrigatório)
- `401 Unauthorized` - Falha na autenticação. - **Resposta**
- `403 Forbidden` - Sem permissão - `lista`(array)
- `404 Not Found` - O recurso solicitado não foi encontrado. - `descricao`(string): Descrição do débito principal.
- `422 Unprocessable Entity` - Erro de validação. - `exercicio`(int): Exercício do pagamento do débito principal.
- `500 Internal Server Error` - Erro no servidor. - `debitoDevido`(string): Tipo de débito que foi detalhado
- `502 Bad Gateway` - Erro de proxy - `debitos`(array): A lista de débito que compoem o tipo de débito que foi detalhando.
- `503 Service Unavailable` - Servidor não está pronto para requisição - `guid`(int): Identificação do débito.
``` - `descricao`(string): Descrição do débito.
- `dataVencimento`(DateTime): Data de vencimento do débito.
# Detalhes do Endpoint: 'v1/obter-todos-debitos-detalhados' - `valor`(decimal): Valor do débito.
- `pagamentoObrigatorio`(boolean): Indica se é obrigatório o pagamento do débito para o tipo selecionado.
### Descrição
Retorna a lista de todos os tipo de débitos detalhados.
### Parâmetros
- `placa` (obrigatório)
- Tipo: `string`
- `renavam` (obrigatório)
- Tipo: `string`
- `documentoProprietario` (obrigatório)
- Tipo: `string`
### Requisição
```bash
curl -X 'GET' \
'https://api.detranveiculo.hom.es.gov.br/guia-pagamento/internet-banking/v1/obter-tipo-debito-detalhado/{placa}/{renavam}/{documentoProprietario}?debitoDevido=IPVAExercicio' \
-H 'accept: text/plain' \
-H 'Authorization: Bearer SEU_TOKEN_DE_API'
```
### Resposta
- Descricao (string): Uma breve descrição do débito devido.
- Exercicio (integer): Ano do exercício referente ao débito.
- DebitoDevido (Enum): Tipo do débito devido, neste caso, "IPVAExercicio".
- Values: [IPVAExercicio, IPVAAnterior, DPVATExercicio, DPVATAnterior, LicenciamentoExercicio, LicenciamentoAnterior, Multa]
- Debitos (array): Lista de débitos associados.
- Guid (integer): Identificador único do débito.
- Descricao (string): Descrição do débito.
- DataVencimento (string, formato datetime): Data de vencimento do débito.
- Valor (decimal): Valor do débito.
- PagamentoObrigatorio (boolean): Indica se o pagamento é obrigatório.
```json ```json
[
{ {
"descricao": "string", "descricao": "string",
"exercicio": 0, "exercicio": 0,
...@@ -167,25 +81,108 @@ curl -X 'GET' \ ...@@ -167,25 +81,108 @@ curl -X 'GET' \
{ {
"guid": 0, "guid": 0,
"descricao": "string", "descricao": "string",
"dataVencimento": "2024-06-03T18:21:00.965Z", "dataVencimento": "2024-06-04T11:03:36.336Z",
"valor": 0, "valor": 0,
"pagamentoObrigatorio": true "pagamentoObrigatorio": true
} }
] ]
} }
]
``` ```
### 4. Obter Todos Tipos de Débitos Detalhados
### Tratamento de Erro - **Endpoint**: `GET /guia-pagamento/internet-banking/v1/obter-veiculo`
```markdown - **Descrição**: Retorna algumas informações do veículo.
# Tratamento de Erros - **Parâmetros**:
- `placa`(string, obrigatório)
Nossa API retorna códigos de status HTTP para indicar o sucesso ou falha de uma requisição. - `renavam`(string, obrigatório)
- `documentoProprietario`(string, obrigatório)
- `401 Unauthorized` - Falha na autenticação. - **Resposta**
- `403 Forbidden` - Sem permissão - `proprietario` (object): Detalhes do proprietário do veículo.
- `404 Not Found` - O recurso solicitado não foi encontrado. - `nome` (string): Nome do proprietário.
- `422 Unprocessable Entity` - Erro de validação. - `docPrincipal` (string): Documento principal do proprietário (CPF ou CNPJ).
- `500 Internal Server Error` - Erro no servidor. - `placa` (string): Placa do veículo.
- `502 Bad Gateway` - Erro de proxy - `renavam` (string): Número do Registro Nacional de Veículos Automotores.
- `503 Service Unavailable` - Servidor não está pronto para requisição - `marcaModelo` (string): Marca e modelo do veículo.
- `anoFabricacao` (int): Ano de fabricação do veículo.
```json
{
"proprietario": {
"nome": "string",
"docPrincipal": "string"
},
"placa": "string",
"renavam": "string",
"marcaModelo": "string",
"anoFabricacao": 0
}
```
### 5. Gerar Guia de Pagamento
- **Endpoint**: `PUT/guia-pagamento/internet-banking/v1/gerar-guia`
- **Descrição**: Retorna todos os tipos de débitos e o débitos que fazem parte do tipo de débito.
- **Parâmetros**:
- `debitoDevido`(string, obrigatório)
- `placa`(string, obrigatório)
- `renavam`(string, obrigatório)
- `documentoProprietario`(string, obrigatório)
- `guidsDebito`(array<int>, obrigatório): lista dos guids de débitos que serão pagos. Sendo obrigatório informar todos os guids debitos que estão marcados como pagamento obrigatório.
```json
{
"debitoDevido": "IPVAExercicio",
"placa": "string",
"renavam": "string",
"documentoProprietario": "string",
"guidsDebito": [
0
]
}
```
- **Resposta**
- `nome` (string): Nome associado ao registro.
- `placa` (string): Placa do veículo.
- `renavam` (string): Número do Registro Nacional de Veículos Automotores.
- `marcaModelo` (string): Marca e modelo do veículo.
- `pixCode` (string): Código PIX para realização de pagamentos.
- `codigoBarra` (base64): Código de barras para pagamento.
- `linhaDigitavel` (string): Linha digitável do código de barras.
- `numero` (string): Número do documento ou do registro.
- `dataVencimento` (string): Data de vencimento no formato ISO 8601 (YYYY-MM-DDTHH:MM:SS.sssZ).
- `valor` (decimal): Valor total a ser pago.
- `guid` (string): Identificador único global para o registro.
- `pdfBase64` (base64): Documento associado em formato PDF codificado em base64.
- `composicao` (array<object>, obrigatório): Lista detalhando a composição do débito.
- `descricaoDebito` (string): Descrição do débito.
- `datavencimento` (string): Data de vencimento específica do débito no formato ISO 8601.
- `valorvencimento` (decimal): Valor original de vencimento.
- `valorCorrigido` (decimal): Valor corrigido com acréscimos ou deduções.
- `valorDesconto` (decimal): Valor de desconto aplicado.
- `valorJuros` (decimal): Valor de juros aplicados.
- `valorMulta` (decimal): Valor da multa aplicada.
- `valorAtualizado` (decimal): Valor total atualizado após correções.
```json
{
"nome": "string",
"placa": "string",
"renavam": "string",
"marcaModelo": "string",
"pixCode": "string",
"codigoBarra": "string",
"linhaDigitavel": "string",
"numero": "string",
"dataVencimento": "2024-06-04T11:05:24.653Z",
"valor": 0,
"guid": "string",
"pdfBase64": "string",
"composicao": [
{
"descricaoDebito": "string",
"datavencimento": "2024-06-04T11:05:24.653Z",
"valorvencimento": 0,
"valorCorrigido": 0,
"valorDesconto": 0,
"valorJuros": 0,
"valorMulta": 0,
"valorAtualizado": 0
}
]
}
``` ```
\ No newline at end of file