📖Padrões de Requisição

Conceito

Todas as requisições feitas em nossa API possuem dados de entrada. Cada rota oferecida possui padrões específicos que variam de uma simples data à conjuntos de dados complexos ou mesmo parâmetros de paginação do resultado que será recebido.

Date

Sua requisição deve enviar uma data válida no padrão YYYY-MM-DD como por exemplo 2021-01-12.

DateTime

Sua requisição deve enviar um date time (data + hora) no padrão YYYY-MM-DD THH:NN:SSZ válido , importante observar que as transações são gravadas em timezone do Brazil (UTC-03:00), como por exemplo 2021-01-01T15:35:52.920Z

GUID

Um identificador universal (ou GUID) é um valor gerado pelo sistema de forma aleatória e única e contém uma string (cadeia de caracteres) de 36 caracteres no padrão 00000000-0000-0000-0000-000000000000

Em geral, o GUID é parte da resposta de uma requisição que o usuário executa em transações de criação de conteúdo, como por exemplo 8FC4F215-93A6-EB11-8491-94F330FE9C1A

Moeda

Os valores enviados no sistema não utilizam separadores, assim sendo todo valor com casas decimais deve ser enviado acrescido ao final do valor real. Por exemplo, uma valor de R$ 105,24 deve ser enviado como 10524

Percentual

Os percentuais são valores inteiros limitados ao intervalo 0 à 100, qualquer valor fora desta faixa é ignorado e não suporta casas decimais.

Pessoa

O tipo de pessoa é um texto padrão de 1 caractere que deve conter um dos dois valores

F – para pessoa física

J – para pessoa jurídica

Sexo

O sexo é um texto padrão de 1 caractere que deve conter um dos dois valores

F – Feminino

M – Masculino

CPF/CNPJ

Este dado é um conjunto de 11 (CPF) ou 14 (CNPJ) números que é devidamente validado através do cálculo do digito verificador dos módulos correspondentes. Na prática, significa que todo CPF ou CNPJ enviado será consistindo, e deve ser composto obrigatoriamente de números.

CEP

O CEP é um conjunto de 8 números, sem uso de separadores. Atenção especial à situações como boleto que requer um CEP válido para fins de endereçamento.

Telefone

Dividido nas requisições em dois campos distintos, o telefone é a conjunção do DDD e o número do telefone (fixo ou celular). Deve ser enviado na requisição composto somente de números e pode variar entre 10 e 11 caracteres.