🤖Mapeamento da API

Loyalty API

Limites: Há um limite de requisições que podem ser enviadas para a API por segundo, atualmente nosso limite de requisições por IP são 6 requisições a cada segundo no plano Max, no plano Corp os limites são maiores de acordo com a faixa de clientes contratada. Ao ultrapassar esse limite a API retorna o status code 403 Forbidden

Todo retorno da API exibe um parâmetro de resposta e uma mensagem de erro quando houver algo diferente de uma requisição realizada com sucesso.

Parâmetro	Descrição	Tipo
CodigoResposta	Identificação numérica da resposta	int
MensagemErro	Mensagem retornada pela API quando há uma resposta diferente de OK	string

Detalhes do CodigoResposta

Valor	Descrição
100	A requisição foi realizada sem erros.
101	Houve um erro interno no servidor.
102	Parâmetros obrigatórios não foram passados na requisição.
103	Consumidor não foi encontrado no cliente autenticado pela API.
104	Usuário e senha são inválidos para gerar o token de autenticação para os demais endpoints.
105	Prêmio vinculado a ação de pontuação não foi encontrado no cliente autenticado pela API.
106	Consumidor não possui pontos suficientes para trocar pelo prêmio escolhido.
108	A pontuação já foi realizada para um consumidor com o mesmo verificador vinculado a pontuação.
109	O cartão já está vinculado a outro consumidor.
110	O consumidor já está vinculado ao programa de fidelidade.
111	O e-mail informado já está vinculado a outro consumidor.
112	O estorno de pontos já foi realizado para a pontuação vinculado a um verificador.
113	O estorno de pontos é maior que o saldo do consumidor.
114	A operação de estorno não pode ser realizada sem o verificador da pontuação.
115	Prêmio já está cadastrado na plataforma.
116	Voucher já está cadastrado na plataforma.
117	Limite consumidores atingido.
118	Voucher não existe na plataforma.
119	Voucher já foi resgatado.
120	Consumidor está cadastrado, porém inativado no progrma de fidelidade
121	Senha incorreta ou login bloqueado
122	Vale compras está expirado
123	Vale compras não existe ou ele não está mais disponível
124	Vale compras já foi resgatado anteriormente

Na maior parte dos endpoints os parâmetros de requisição contém os atributos “cpf”,”cartao” e ”telefone”. É obrigatório informar somente 1 desses atributos, pois ele será o identificador do seu consumidor no Programa de Fidelidade.