v1

latestOpenAPI 3.1.02026-07-2678221359.6 KB

AutoRadar

Criar Assinatura

Cria uma nova assinatura

Este endpoint permite que você cadastre um novo veículo no serviço AutoRadar

Funcionalidade síncrona, o retorno de sucesso ou erro é retornado imediatamente na requisição.
Quando uma assinatura é criada, ela será agendada seguindo as regras contratuais e não será consultada imediatamente.
Erro 412 está mapeado para situações que impedem a criação de uma assinatura
- Quando não há suporte para o UF informado
- Os estados suportados no momento são SP, RJ, PR, MG, DF, ES, MT, RS, BA e SC

Regras de agendamento de consulta

Na criação de uma nova assinatura, o algoritmo selecionará uma data base calculada como a soma da data atual com o parâmetro de periodicidade. Com essa data base, será determinado um período através da subtração do offset e adição do intervalo de vencimento. Dentro desse período, será escolhida uma data de balanceamento para distribuir de maneira eficiente a consulta.

Exemplo:

Data atual (D): 1º de janeiro
Parâmetro de periodicidade (X): 15 dias
Offset de consulta (Y): 5 dias
Data de vencimento (Z): 6 dias

Cálculo da Data Base (F):

F = D + X = 16 de janeiro

Determinação do Período:

Período = (F - Y) até (F + Z)

Ou seja,

Período = (16/01 - 5) até (16/01 + 6)

Portanto, a data da próxima consulta ocorrerá entre os dias 11 de janeiro e 22 de janeiro.

post/autoradar/

Request body

license_platestring required

Placa do veiculo

uf'AC' | 'AL' | 'AP' | 'AM' | 'BA' | 'CE' | 'DF' | 'ES' | 'GO' | 'MA' | 'MT' | 'MS' | 'MG' | 'PA' | 'PB' | 'PR' | 'PE' | 'PI' | 'RJ' | 'RN' | 'RS' | 'RO' | 'RR' | 'SC' | 'SP' | 'SE' | 'TO'

documentstring nullable

Documento do proprietario

renavamstring nullable

Renavam do veiculo

chassisstring nullable

Chassi do veiculo

external_idstring nullable

Identificador externo do parceiro

channel'embedded' | 'offer' | 'application'

Response

Assinatura criada com sucesso

idstring uuid required

Identificador da assinatura

store_idinteger nullable

Identificador do estabelecimento

created_atstring date-time required

Data e hora da criação da assinatura

updated_atstring date-time required

Data e hora da atualização da assinatura

is_activeboolean

Indica se a assinatura esta ativa

is_canceledboolean

Indica se a assinatura foi cancelada

external_idstring nullable

Identificador da assinatura no parceiro

channel'embedded' | 'offer' | 'application'

canceled_reasonstring nullable

Motivo de cancelamento

update_action_notification_sentboolean

Indica que o cliente foi notificado caso os requisitos mínimos não tenham sido atendidos

enqueuedboolean

Indica se a inscrição está em fila de processamento

last_enqueued_atstring date-time nullable

Data e hora da inscrição em fila de processamento