Pular para o conteúdo principal

Padrões

Para facilitar a integração e garantir a integridade da informação, foram definidos alguns padrões que são seguidos em toda a API.

Valores Monetários​

Exemplos:

10000
12345
98741
1223
1
0

As APIs assumem que todos os valores monetários enviados são em Reais Brasileiros. Os valores devem ser enviados como inteiro em centavos.

Data e Hora com Fuso Horário​

Alguns exemplos:

2019-10-15T22:35:12-03:00
2018-05-01T13:32:11+00:00
2019-05-01T00:00:00+00:00

É representada conforme a ISO 8601. Neste caso, o fuso-horário é colocado logo após o horário e deve representar o fuso do local onde aquele dado será valido. Por exemplo, se um aluguel estiver marcado para começar às 09:30 no aeroporto de Brasília, o horário enviado deverá ser representado por 09:30-03:00, se o aluguel estiver marcado para começar às 09:30 em Manaus, deverá ser representado por 09:30-04:00.

A máscara utilizada para validação é a seguinte:

YYYY-MM-ddThh:mm:ss±hh:mm

Data e Hora sem Fuso Horario​

Alguns exemplos:

2019-10-15T22:35:12
2018-05-01T13:32:11
2019-05-01T00:00:00

É representada conforme a ISO 8601. Dados que independem de fuso-horário deverão ser enviados sem ele, sempre em UTC, com a letra Z indicando que este dado está em UTC. O seguinte formato, portanto, será validado:

YYYY-MM-ddThh:mm:ssZ

Data​

Alguns exemplos

2019-10-15
2019-01-01
2017-03-20

No caso de campos que recebem somente data, uma data de nascimento, por exemplo, somente a data, sem nenhum horário deve ser enviada com o seguinte formato:

YYYY-MM-dd

Documentos​

Uma vez que os números de documento são bastante variados e muitos deles possuem caracteres que não se enquadram como numéricos, definem-se todos os números de documento como string. Outro bom motivo para definí-los como string é evitar que os zeros à esquerda desapareçam. Documentos previstos nesta página possuem uma máscara bem definida e estarão sujeitos a validação. O restante dos documentos, como RG, dada sua falta de padronização, não serão validados.

CPF​

Exemplos de CPFs válidos contra a máscara definida:

123.456.789-12
321.987.543-23
111.283.333-00

Exemplos de CPFs inválidos contra a máscara definida:

8.577.477-8
08.104.627/0001-23
123.456.789-1
23.456.789-01

O CPF é sempre definido como uma string e será validado conta a máscara:

###.###.###-##

CNPJ​

Exemplos de CNPJs válidos contra a máscara definida:

08.104.627/0001-02
01.079.210/0114-67
32.402.502/0001-35

Exemplos de CNPJs inválidos contra a máscara definida:

8.577.477-8
123.456.789-12
321.987.543-23
32.402.502/0001-3
032.402.502/0001-3

O CNPJ é sempre definido como uma string e será validado conta a máscara:

##.###.###/####-##

IP​

Exemplos de IPs válidos contra a máscara definida:

201.81.161.86
201.081.161.86
201.81.161.086
201.81.0.1

Exemplos de IPs inválidos:

201.81..86
358.81.161.86
201.81.161

IPs deverão ser enviados sempre em IPv4, zeros à esquerda poderão ou não ser enviados, respeitando a seguinte máscara:

###.###.###.###