Manual de Integração por Web Service

Sistema de Registro de Contratos SIELLO

Versão 1.2

ST SRTVS QUADRA 701 BLOCO “O” ENTRADA 110 SALA 104 - EDIFICIO MULTIEMPRESARIAL
ASA SUL - CEP: 70.340-000 – BRASILIA-DF
 Histórico de Versões

Versão Responsável Observações

1.0 André Ferreira dos Santos Versão inicial
1.1 André Ferreira dos Santos Mudança na URL dos serviços.
Inclusão do serviço de envio de imagens
1.2 André Ferreira dos Santos
PDF

ST SRTVS QUADRA 701 BLOCO “O” ENTRADA 110 SALA 104 - EDIFICIO MULTIEMPRESARIAL
ASA SUL - CEP: 70.340-000 – BRASILIA-DF
 Sumário

Definições Gerais .......................................................................................................... 4

Serviços......................................................................................................................... 5
1. Autorização/Autenticação .................................................................................... 5
2. Registro de contratos .......................................................................................... 6
a. Definição .......................................................................................................... 6
b. URL ............................................................................................................... 6
c. Requisição ....................................................................................................... 6
d. Retorno ......................................................................................................... 7
e. Detalhamento ................................................................................................... 7
3. Sincronizar Registro .......................................................................................... 10
a. Definição ........................................................................................................ 10
b. URL ............................................................................................................. 10
c. Requisição ..................................................................................................... 10
d. Retorno ....................................................................................................... 11
e. Detalhamento ................................................................................................. 11
4. Enviar imagem do contrato ................................................................................ 12
a. Definição ........................................................................................................ 12
b. URL ............................................................................................................. 12
c. Requisição ..................................................................................................... 12
d. Retorno ....................................................................................................... 12
e. Detalhamento ................................................................................................. 12

ST SRTVS QUADRA 701 BLOCO “O” ENTRADA 110 SALA 104 - EDIFICIO MULTIEMPRESARIAL
ASA SUL - CEP: 70.340-000 – BRASILIA-DF
 Definições Gerais

1. Todos os webservices disponibilizados pela Siello utilizam o padrão

REST;
2. As requisições deverão enviar os dados no formato JSON;
3. As respostas serão recebidas também no formato JSON;
4. Os serviços com HTTP RESPONSE CODE diferentes de “200” (OK) não
foram executados com sucesso, devendo o usuário verificar a mensagem de retorno
para saber qual o erro está impedindo o sucesso da requisição;
5. A URL dos serviços é composta pelo [domínio da Siello] + [contexto da
aplicação (core)] + [API] + [método].
a. DOMÍNIO DE PRODUÇÃO: https://sielloregistros.com
b. DOMÍNIO DE HOMOLOGAÇÃO: https://sielloregistros.com.br

ST SRTVS QUADRA 701 BLOCO “O” ENTRADA 110 SALA 104 - EDIFICIO MULTIEMPRESARIAL
ASA SUL - CEP: 70.340-000 – BRASILIA-DF
 Serviços

1. Autorização/Autenticação
a. Os métodos utilizam a autenticação padrão de serviços por “Basic
Authentication” no header das requisições.

Ex.:
Usuário: teste
Senha: 1
Authorization : Basic dGVzdGU6MQ==

b. O usuário e senha serão fornecidos pela Siello e não serão passíveis de

alteração pelo cliente. Caso haja a necessidade, o cliente deverá
solicitar à Siello, a qual providenciará a alteração dos dados de
autenticação.
c. Todos os serviços possuem uma camada de segurança que só permite
a requisição por IP’s devidamente liberados. No início dos testes de
integração, será fornecido o acesso ao ambiente de homologação, bem
como serão realizadas as devidas liberações. Após concluída a etapa de
homologação, a Siello fornecerá os dados de acesso à produção.
d. O cliente deverá enviar à Siello os IP’s que deseja liberação nos
respectivos ambientes de homologação e produção.

ST SRTVS QUADRA 701 BLOCO “O” ENTRADA 110 SALA 104 - EDIFICIO MULTIEMPRESARIAL
ASA SUL - CEP: 70.340-000 – BRASILIA-DF
 2. Registro de contratos
a. Definição: Serviço responsável por salvar (novo registro ou edição) os
registros e sincronizá-los com o DETRAN.
b. URL: https://{dominio}/core/contrato/cadastrar
c. Requisição:
i. Método (Request Method): POST
ii. Tipo: JSON
iii. Request params: Basic Auth (Authorization)
iv. Body:

{
"numero":"",
"flagTransacao":1,
"nroAditivo":"",
"data":"",
"dataContratoPrincipal":"",
"tipoContrato":{
"id":1
},
"tipoRegistro":"",
"valorDivida":"",
"nroParcelas":0,
"valorParcela":"",
"taxaJurosMes":"",
"taxaJurosAno":"",
"valorIof":"",
"correcaoMonetaria":"",
"taxaMulta":"",
"taxaMora":"",
"comissao":"",
"penalidade":"",
"dataVencPrimeiraParcela":"",
"dataVencUltimaParcela":"",
"dataLiberacaoCredito":"",
"indice":"",
"ufLiberacaoCredito":"",
"municipioLiberacaoCredito":"",
"nroGrupoConsorcio":0,
"nroCotaConsorcio":0,
"devedor":{
"tipo":"F",
"cpfCnpj":"",
"nome":"",
"endereco":"",
"numero":"",
"complemento":"",
"bairro":"",
"cep":"",
"telefone":"",

ST SRTVS QUADRA 701 BLOCO “O” ENTRADA 110 SALA 104 - EDIFICIO MULTIEMPRESARIAL
ASA SUL - CEP: 70.340-000 – BRASILIA-DF
 "celular":"",
"estado":"",
"municipio":"",
"codigoMunicipio":"",
},
"credor":{
"pessoa":{
"cpfCnpj":""
}
},
"veiculos":[
{
"id":"",
"chassi":"",
"placa":"",
"renavam":"",
"gravame":"",
"uf":"",
"ufLicenciamento":"",
"anoFabricacao":0,
"anoModelo":0,
"marca":"",
"modelo":"",
"motivoCancelamento":"",
"remarcado":false
}
]
}

d. Retorno:
i. Tipo: JSON
ii. Código de sucesso: 200
iii. Body:

[
{
"id":0,
"chassi":"",
"gravame":"",
"codigo":0,
"mensagem":""
}
]

e. Detalhamento

ST SRTVS QUADRA 701 BLOCO “O” ENTRADA 110 SALA 104 - EDIFICIO MULTIEMPRESARIAL
ASA SUL - CEP: 70.340-000 – BRASILIA-DF
 i. Campos do JSON de REQUISIÇÃO (Request)

Campo Tipo Tam. Obrigatório Observação

VEÍCULO
Id Numérico 10 Não Somente nos casos
de edição
anoFabricacao Numérico 4 Sim
anoModelo Numérico 4 Sim
Chassi Texto 21 Sim
Gravame Texto 21 Sim
Marca Texto 50 Não
Modelo Texto 50 Não
Placa Texto 7 Não
Remarcado Boolean Sim “true” ou “false”
Renavam Texto 50 Não
Uf Texto 2 Não UF da placa. Informar
somente caso informe
a placa.
ufLicenciamento Texto 2 Sim
motivoCancelamento Texto 300 Não
CONTRATO
flagTransacao Numérico 1 Sim 1. Inclusão do
registro de contrato
2. Alteração no
registro de contrato
3. Inclusão do
aditivo de contrato
4. Alteração do
aditivo de contrato
5. Cancelamento
de contrato
6. Baixa de
contrato
Comissão Texto 10 Não 2 casas decimais
separadas por “.”. Ex.:
“1.00”
correcaoMonetaria Texto 10 Não 2 casas decimais
separadas por “.”. Ex.:
“1.00”
Data Texto 10 Sim Formato:
DD/MM/AAAA
dataContratoPrincipal Texto 10 Não Formato:
DD/MM/AAAA
dataLiberacaoCredito Texto 10 Sim Formato:
DD/MM/AAAA
dataVencPrimeiraParcela Texto 10 Sim Formato:
DD/MM/AAAA
dataVencUltimaParcela Texto 10 Sim Formato:
DD/MM/AAAA
Indice Texto 10 Não
municipioLiberacaoCredito Texto 100 Sim
nroAditivo Texto 50 Não
nroCotaConsorcio Numérico 10 Não
nroGrupoConsorcio Numérico 10 Não
nroGrupoConsorcio Numérico 10 Sim
Numero Texto 50 Sim Número do contrato
Penalidade Texto 200 Não

ST SRTVS QUADRA 701 BLOCO “O” ENTRADA 110 SALA 104 - EDIFICIO MULTIEMPRESARIAL
ASA SUL - CEP: 70.340-000 – BRASILIA-DF
taxaJurosAno Texto 10 Não 2 casas decimais
separadas por “.”. Ex.:
“1.00”
taxaJurosMes Texto 10 Não 2 casas decimais
separadas por “.”. Ex.:
“1.00”
taxaMora Texto 10 Não 2 casas decimais
separadas por “.”. Ex.:
“1.00”
taxaMulta Texto 10 Não 2 casas decimais
separadas por “.”. Ex.:
“1.00”
TipoContrato – ID Numérico 2 Sim 1 - ARRENDAMENTO
MERCANTIL
2 - RESERVA DE
DOMÍNIO
3 - ALIENAÇÃO
FIDUCIÁRIA
4 - PENHOR
tipoRegistro Texto 20 Sim “ADITIVO” ou
“REGISTRO”
ufLiberacaoCredito Texto 2 Sim
valorDivida Texto 10 Sim 2 casas decimais
separadas por “.”. Ex.:
“1.00”
valorIof Texto 10 Não 2 casas decimais
separadas por “.”. Ex.:
“1.00”
valorParcela Texto 10 Não 2 casas decimais
separadas por “.”. Ex.:
“1.00”
Credor – pessoa – cpfCnpj Texto 14 Não
DEVEDOR
Bairro Texto 100 Sim
Celular Texto 15 Não Formato: “(00) 00000-
0000”
Cep Texto 8 Sim Somente números
complemento Texto 100 Não
cpfCnpj Texto 14 Sim Somente números
Endereço Texto 200 Sim
Estado Texto 2 Sim UF
Município Texto 100 Sim
Código do município Numérico 5 Sim
Nome Texto 100 Sim
Numero Texto 10 Sim
Telefone Texto 15 Sim Formato: “(00) 0000-
0000”
Tipo Texto 1 Sim Física – “F” ou
Jurídica – “J”

ii. Campos do JSON de RESPOSTA (Reponse)

Campo Tipo Tamanho Obrigatório Definição
Id Numérico 10 Não Número do registro no Sistema
Siello. Deverá ser usado para o
caso de edição ou posterior
sincronização do registro.
Chassi Texto 21 Não
Gravame Texto 21 Não

ST SRTVS QUADRA 701 BLOCO “O” ENTRADA 110 SALA 104 - EDIFICIO MULTIEMPRESARIAL
ASA SUL - CEP: 70.340-000 – BRASILIA-DF
 Código Numérico 10 Sim Ver item 2.e.iii (abaixo)
Mensagem Texto 200 Sim Mensagem de retorno do serviço
Obs.: A resposta será sempre em forma de lista, mesmo que o retorno seja único.

iii. Códigos de RESPOSTA (Reponse)

Código Descrição
9999 Erro na comunicação com o sistema do DETRAN
8888 Erro inesperado: [detalhamento do erro]
7777 Erro na validação dos dados: [detalhamento do erro]
1000 Não foi possível localizar a credora
1001 Não foi possível cadastrar/editar o contrato
1002 Não foi possível registrar/editar o veículo
1003 Não foi possível cadastrar o devedor
1004 Campo(s) obrigatório(s) não preenchido(s): [detalhamento dos campos não
preenchidos]
1005 Não foi possível localizar o contrato/aditivo para edição ou o contrato já se
encontra cancelado/baixado/fechado
1006 A edição/cancelamento/baixa do contrato/aditivo só pode ser feita com um
veículo por vez.
1007 Cancelado com sucesso.
1008 Baixado com sucesso.
1009 CPF/CNPJ do credor inválido.
1010 CPF/CNPJ do devedor inválido.
Além desses códigos, serão retornados neste campo os códigos da
comunicação com os DETRAN’s. Cada estado mantém uma tabela diferente.
Consulte a Siello para saber os códigos de SUCESSO de cada estado.
Lembrando que, dependendo do estado, a comunicação é realizada em duas
“transações” separadas (785 e 700), sendo que para se considerar SUCESSO,
as duas transações devem ter tido resposta positiva.

3. Sincronizar Registro
a. Definição: Serviço responsável por sincronizar o(s) registro(s) que por
algum motivo não foi(ram) sincronizado(s) no momento do cadastro.
b. URL: https://{dominio}/core/contrato/ sincronizarRegistro
c. Requisição:
iv. Método (Request Method): POST
v. Tipo: JSON
vi. Request params: Basic Auth (Authorization)
vii. Body:

{
"id":"",
"chassi":"",
"gravame":""
}

ST SRTVS QUADRA 701 BLOCO “O” ENTRADA 110 SALA 104 - EDIFICIO MULTIEMPRESARIAL
ASA SUL - CEP: 70.340-000 – BRASILIA-DF
 d. Retorno:
i. Tipo: JSON
ii. Código de sucesso: 200
iii. Body:

[
{
"id":0,
"chassi":"",
"gravame":"",
"codigo":0,
"mensagem":""
}
]

e. Detalhamento

i. Campos do JSON de REQUISIÇÃO (Request)

Campo Tipo Tam. Obrigatório Observação

VEÍCULO
Id Numérico 10 Não ID gerado pelo
sistema Siello no
momento do cadastro
Chassi Texto 21 Não Só será obrigatório
caso o ID não seja
informado
Gravame Texto 21 Não Só será obrigatório
caso o ID não seja
informado

ii. Campos do JSON de RESPOSTA (Reponse)

Campo Tipo Tamanho Obrigatório Definição
Id Numérico 10 Não
Chassi Texto 21 Não
Gravame Texto 21 Não
Código Numérico 10 Sim Ver item 3.e.iii (abaixo)
Mensagem Texto 200 Sim Mensagem de retorno do serviço
Obs.: A resposta será sempre em forma de lista, mesmo que o retorno seja único.

iii. Códigos de RESPOSTA (Reponse)

Código Descrição
9999 Erro na comunicação com o sistema do DETRAN
8888 Erro inesperado: [detalhamento do erro]
7777 Erro na validação dos dados: [detalhamento do erro]
1000 Não foi possível localizar a credora
1001 Não foi possível cadastrar/editar o contrato

ST SRTVS QUADRA 701 BLOCO “O” ENTRADA 110 SALA 104 - EDIFICIO MULTIEMPRESARIAL
ASA SUL - CEP: 70.340-000 – BRASILIA-DF
1002 Não foi possível registrar/editar o veículo
1003 Não foi possível cadastrar o devedor
1004 Campo(s) obrigatório(s) não preenchido(s): [detalhamento dos
campos não preenchidos]
1005 Não foi possível localizar o contrato/aditivo para edição ou o contrato
já se encontra cancelado/baixado/fechado
1006 A edição/cancelamento/baixa do contrato/aditivo só pode ser feita
com um veículo por vez.
1007 Cancelado com sucesso.
1008 Baixado com sucesso.
1009 CPF/CNPJ do credor inválido.
1010 CPF/CNPJ do devedor inválido.
Além desses códigos, serão retornados neste campo os códigos da
comunicação com os DETRAN’s. Cada estado mantém uma tabela diferente.
Consulte a Siello para saber os códigos de SUCESSO de cada estado.
Lembrando que, dependendo do estado, a comunicação é realizada em duas
“transações” separadas (785 e 700), sendo que para se considerar SUCESSO,
as duas transações devem ter tido resposta positiva.

4. Enviar imagem do contrato

a. Definição: Serviço responsável por enviar as imagens dos contratos
registrados
b. URL: https://{dominio}/core/arquivo/uploadExternal/{chassiOuGravame}
c. Requisição:
viii. Método (Request Method): POST
ix. Tipo: JSON
x. Request params: Basic Auth (Authorization)
xi. Query params: chassiOuGravame – Chassi ou gravame do
registro correspondente
xii. Body:

{
"nome":"",
"data":""
}

d. Retorno:
i. Tipo: VOID
ii. Código de sucesso: 200
iii. Body: vazio

e. Detalhamento

iv. Campos do JSON de REQUISIÇÃO (Request)

ST SRTVS QUADRA 701 BLOCO “O” ENTRADA 110 SALA 104 - EDIFICIO MULTIEMPRESARIAL
ASA SUL - CEP: 70.340-000 – BRASILIA-DF
 Campo Tipo Tam. Obrigatório Observação
ARQUIVO
Nome Texto 100 Sim Nome do arquivo com
a extensão (ex.
CHASSI.pdf)
Data Texto - Sim Byte[] do arquivo em
base64

ST SRTVS QUADRA 701 BLOCO “O” ENTRADA 110 SALA 104 - EDIFICIO MULTIEMPRESARIAL
ASA SUL - CEP: 70.340-000 – BRASILIA-DF