Através desta documentação deverá ser possível fazer a integração com a API do Pontosmania, caso alguma dúvida permaneça você pode entrar em contato com o suporte especializado através do e-mail pontosmania@pontosmania.com.br.

A API utiliza o padrão de arquitetura REST. Neste padrão, são utilizados métodos HTTP (GET, POST, PUT, DELETE) em conjunto com determinados recursos disponíveis através de uma URL para representar uma determinada ação.

O formato JSON é utilizado para transferência de dados. Sempre que é feita uma chamada HTTP é devolvido um código de retorno. Este código irá informar também se a requisição foi aceita ou se ocorreu algum erro, da seguinte forma:

{
"http_code": 400,
"status": "Unauthorized",
"mensagem": "E02 - Credenciais inválidas. Tente novamente ou verifique com o administrador se seu usuário está bloqueado."
}

Autenticação

A autenticação é realizada por meio de um token. Quando a API for habilitada para sua empresa, forneceremos uma chave secreta e única, que deverá ser utilizada para todas as operações. Para autenticar, adicione o token ao cabeçalho da requisição.

Api-Key: XXXXXXXXXXXXXXXXXXXXXXXXX

Ambiente

A API da Pontosmania oferece dois ambientes: homologação e produção.

Homologação

O ambiente de homologação permite ajustar a integração de forma segura, evitando qualquer impacto no funcionamento da nossa operação.

Produção

Este é o ambiente principal. Recomendamos que o utilize somente após a conclusão de todo o processo de integração.

O endereço dos servidores são os seguintes:

Produtos

Parâmetro Descrição Tipo
ref Chave de referência gerada pela sua aplicação. Obrigatório String
descricao Descrição do produto. Obrigatório String
familia Família do produto. Opcional Object
grupo Grupo do produto. Opcional Object
linha Linha do produto. Opcional Object
marca Marca do produto. Opcional Object
ativo Status do cadastro. (padrão = 1) Opcional Boolean
{
"produtos": [
{
"ref": "00012",
"descricao": "ÁGUA MINERAL 510ML",
"familia": {
"ref": "",
"descricao": ""
},
"grupo": {
"ref": "",
"descricao": ""
},
"linha": {
"ref": "",
"descricao": ""
},
"marca": {
"ref": "",
"descricao": ""
},
"ativo": true
}
]
}

Modalidades de Pagamento

Parâmetro Descrição Tipo
ref Chave de referência gerada pela sua aplicação. Obrigatório String
descricao Descrição da modalidade de pagamento. Obrigatório String
ativo Status do cadastro. (padrão = 1) Opcional Boolean
{
"modalidades": [
{
"ref": "0001",
"descricao": "A VISTA",
"ativo": 1
}
]
}

Vendas

Parâmetro Descrição Tipo
ref Chave de referência gerada pela sua aplicação. Obrigatório String
cpf_cnpj CPF ou CNPJ do cliente. (somente números) Obrigatório String
tel_contato Telefone de contato do cliente. (somente números) Opcional String
dt_venda Data da venda. Obrigatório String
valor_nota Valor da venda. Obrigatório Decimal
cnpj_loja CNPJ de faturamento da venda. (somente números) Obrigatório String
cpf_cnpj_indicador CPF ou CNPJ do indicador da venda. (somente números) Opcional String
ref_vendedor Chave de referência do vendedor responsável pela venda. Opcional String
chave_nf Chave da NF-e, NFC-e ou NFS-e. Opcional String
dt_cancelamento Data de cancelamento da venda. Opcional String
cancelada Status da venda. (padrão = 0) Opcional Boolean
pagamentos Modalidades de Pagamento Array
produtos Produtos Array
{
"vendas": [
{
"ref": "987654",
"cpf_cnpj": "99999999999",
"dt_venda": "2022-02-17T08:40:30",
"valor_nota": 75.59,
"cnpj_loja": "99999999999999",
"cpf_cnpj_indicador": null,
"ref_vendedor": null,
"chave_nf": "99999999999999999999999999999999999999999999",
"pagamentos": [
{
"ref": "0001",
"valor_forma": 25.59
},
{
"ref": "0006",
"valor_forma": 50.00
}
],
"produtos": [
{
"ref": "00012",
"quantidade": 12,
"valor_unitario": 1.15,
"desconto": 0,
"valor_total": 13.80
}
]
}
]
}

Parâmetro Descrição Tipo
ref Chave de referência gerada pela sua aplicação. Obrigatório String
dt_cancelamento Data de cancelamento da venda. Obrigatório String
{
"vendas": [
{
"ref": "987654"
"dt_cancelamento": "2022-02-17T08:40:30"
}
]
}

Cupons de Resgate

Parâmetro Descrição Tipo
cpf_cnpj CPF ou CNPJ do cliente. (somente números) Obrigatório String
ref Código do cupom. Obrigatório String
?cpf_cnpj=99999999999&ref=A1B2-C3D4-E5F6-G7H8

Parâmetro Descrição Tipo
cpf_cnpj CPF ou CNPJ do cliente. (somente números) Obrigatório String
?cpf_cnpj=99999999999

Parâmetro Descrição Tipo
ref Código do cupom. Obrigatório String
chave_nf Chave da NF-e, NFC-e ou NFS-e. Opcional String
{
"ref": "A1B2-C3D4-E5F6-G7H8",
"chave_nf": "99999999999999999999999999999999999999999999"
}

Parâmetro Descrição Tipo
ref Código do cupom. Obrigatório String
motivo Código do motivo do cancelamento. Opcional String
{
"ref": "A1B2-C3D4-E5F6-G7H8",
"motivo": "02"
}

Clientes

Parâmetro Descrição Tipo
cpf_cnpj CPF ou CNPJ do cliente. (somente números) Obrigatório String
?cpf_cnpj=99999999999

Parâmetro Descrição Tipo
This request does not have params
{
This request does not have a body.
}

Pedidos (App)

Parâmetro Descrição Tipo
id Código de identificação do pedido. Obrigatório String
status Código do novo status do pedido. Obrigatório String
{
"id": "202409123006",
"status": "08"
}

Parâmetro Descrição Tipo
id Código de identificação do pedido. (somente números) Obrigatório String
completo Habilita a visualização de campos adicionais na solicitação de consulta. Opcional Boolean
?cpf_cnpj=99999999999&completo=1

Parâmetro Descrição Tipo
ult_modificacao Data da última alteração do pedido. Obrigatório String
status Código do status do pedido. Opcional String
cpf_cnpj CPF ou CNPJ do cliente. (somente números) Opcional String
completo Habilita a visualização de campos adicionais na solicitação de consulta.. Opcional Boolean
?ult_modificacao=2024-09-07

Consulta de Motivos de Cancelamento do Cupom

Parâmetro Descrição Tipo
This request does not have params
{
This request does not have a body.
}

Consulta de Opções de Pagamento do Pedido

Parâmetro Descrição Tipo
This request does not have params
{
This request does not have a body.
}

Consulta de Status do Pedido

Parâmetro Descrição Tipo
This request does not have params
{
This request does not have a body.
}