Esta API permite que os usuários recuperem ofertas em dinheiro da loja, transações, informações da carteira e gerenciem cupons, indicações e informações de níveis de forma eficaz.
Autenticação
Para acessar a API, você precisa incluir uma chave de API nos cabeçalhos da sua solicitação.
Cabeçalho:
Autorização: Portador YOUR_API_KEY
Aceitar: application/json
wpcb: sim
Como gerar a chave da API da Carteira Webplanex?
1. Faça login na sua área de administração da Carteira Webplanex.
2. Acesse Integrações > APIs da Carteira Webplanex.
3. Clique em "Obter Token" botão para gerar token para a loja.
URL base
Todos os endpoints da API podem ser acessados através da seguinte URL base:
https://cashback.webplanex.com/
Endpoints
1. Obter Ofertas
Endpoint: /api/offers?shop={{url da loja Shopify}}&customer={{id do cliente Shopify}}
Método: OBTER
Descrição: Recuperar uma lista de todas as ofertas de pagamento em dinheiro disponíveis na loja.
Resposta:
200 OK
{
"moeda": "Rs.",
"status": 200,
"mensagem": "Sucesso",
"dados": {
"0": {
"id": 1,
"nome": "Compra total",
" "apply_on": "",
"quantidade": 0,
"descrição": "Ganhe 20% de desconto na loja em compras mínimas de R$ 1.",
"tipo": 4,
"criado_em": "2023-12-07T12:03:27.000000Z",
""atualizado_em": "2024-06-20T06:07:49.000000Z",
""mostrar_atributo_do_link": "estilo=\"decoração-de-texto: nenhum;\"",
" "show_description": "Ganhe 20% de desconto na loja em compras totais mínimas de R$ 1.",
"getOfferTypeName": "Compra Total"
},
"1": {
"id": 2,
"nome": "Teste de oferta de coleta",
"Aplicar_em": "coleção",
"Quantidade": 0,
"Descrição": "<a href=\"/coleções/hidrogênio\">Teste de oferta de coleta Hidrogênio</a>",
" "tipo": 0,
""criado_em": "2023-12-26T10:19:12.000000Z",
""atualizado_em": "2024-07-11T04:06:59.000000Z",
"mostrar_atributo_do_link": "",
" "show_description": "<a href=\"/collections/hydrogen\">Teste de oferta de coleção Hidrogênio</a>",
"getOfferTypeName": "Dinheiro da loja em produtos OU coleções"
},
"caminho": "https://cashback.webplanex.com/api/offers",
""por_página": 10,
""próximo_cursor": nulo,
""URL_da_próxima_página": nulo,
"Cursor_anterior": nulo,
"URL_da_página_anterior": nulo
" }
}
2. Obter Cupons
Ponto de extremidade: /api/coupons?shop={{url da loja Shopify}}
Método: OBTER
Descrição: Recuperar uma lista de todoscupons disponíveis.
Resposta:
200 OK
{
"status": 200,
"mensagem": "Sucesso",
"dados": {
"123": {
"código": "xcodecodetset",
"tipo_de_valor": "porcentagem",
"valor": 1,
"cupom_começa_às": "07 de agosto de 2024",
" "cupom_termina_em": "14 de agosto de 2024",
"tipo_de_acréscimo": "%",
"valor_final": "1%",
"detalhes": [
" "1% de desconto em acessórios da coleção",
"Todos os clientes",
"Ativo a partir de 07 de agosto de 2024"
]
},
"456": {
"código": "zcodecodetst",
"tipo_de_valor": "porcentagem",
"valor": 1,
"cupom_começa_às": "07 de agosto de 2024",
" "cupom_termina_em": "14 de agosto de 2024",
"tipo_de_acréscimo": "%",
"valor_final": "1%",
"detalhes": [
" "1% de desconto em acessórios da coleção",
"Todos os clientes",
"Ativo a partir de 07 de agosto de 2024"
]
}
}
}
3. Gerar Link de Indicação
Ponto de Extremidade: /api/referrals?shop={{url da loja Shopify}}
Método: POST
Descrição: Gerar Link de Indicação
Corpo da Solicitação:
{
"customer_id": "{{shopify customer id}}"
}
Resposta:
200 OK
{
"status": 200,
"mensagem": "Sucesso"
}
4. Obter Link de Indicação
Ponto de extremidade: /api/referrals/{{ID do cliente do Shopify}}?shop={{URL da loja do Shopify}}
Método: OBTER
Descrição: Recuperar um link de indicação
Resposta:
200 OK
{
"status": 200,
"mensagem": "Sucesso",
""dados": {
""url_de_referência": "https://xyz.com/d296ef"
" }
}
5. Obter Carteira do Cliente
Endpoint: /api/customerwallet/{{shopify customer id}}?shop={{shopify store url}}
Método: GET
Descrição: Recuperar informações da minha carteira
Resposta:
200 OK
{
"status": 200,
"mensagem": "Sucesso",
"dados": {
"moeda": "Rs.",
"saldo": [
"{
"