Configurar programa de fidelidade
curl --request PUT \
--url https://api.example.com/v1/campaigns/{campaignId}/loyalty \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Clube Pedir Gás",
"description": "Programa de fidelidade do Clube Pedir Gás",
"defaultValidity": "5D",
"defaultPending": "5D",
"programJoinPolicy": "manualJoin",
"programExitPolicy": "keepPoints",
"programRedemptionPolicy": "automatic",
"autoRedemptionSettings": {
"amount": 5,
"couponSettings": {
"pattern": "CLUBE-######",
"validCharacters": [
"A",
"B",
"C",
"D",
"E",
"F",
"G",
"H",
"I",
"J",
"K",
"L",
"M",
"N",
"O",
"P",
"Q",
"R",
"S",
"T",
"U",
"V",
"W",
"X",
"Y",
"Z",
"0",
"1",
"2",
"3",
"4",
"5",
"6",
"7",
"8",
"9"
],
"discount": {
"type": "monetary",
"value": 120
},
"discountLimit": 120,
"validityDuration": "5D",
"pendingDuration": "5D"
}
}
}
'import requests
url = "https://api.example.com/v1/campaigns/{campaignId}/loyalty"
payload = {
"name": "Clube Pedir Gás",
"description": "Programa de fidelidade do Clube Pedir Gás",
"defaultValidity": "5D",
"defaultPending": "5D",
"programJoinPolicy": "manualJoin",
"programExitPolicy": "keepPoints",
"programRedemptionPolicy": "automatic",
"autoRedemptionSettings": {
"amount": 5,
"couponSettings": {
"pattern": "CLUBE-######",
"validCharacters": ["A", "B", "C", "D", "E", "F", "G", "H", "I", "J", "K", "L", "M", "N", "O", "P", "Q", "R", "S", "T", "U", "V", "W", "X", "Y", "Z", "0", "1", "2", "3", "4", "5", "6", "7", "8", "9"],
"discount": {
"type": "monetary",
"value": 120
},
"discountLimit": 120,
"validityDuration": "5D",
"pendingDuration": "5D"
}
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Clube Pedir Gás',
description: 'Programa de fidelidade do Clube Pedir Gás',
defaultValidity: '5D',
defaultPending: '5D',
programJoinPolicy: 'manualJoin',
programExitPolicy: 'keepPoints',
programRedemptionPolicy: 'automatic',
autoRedemptionSettings: {
amount: 5,
couponSettings: {
pattern: 'CLUBE-######',
validCharacters: [
'A',
'B',
'C',
'D',
'E',
'F',
'G',
'H',
'I',
'J',
'K',
'L',
'M',
'N',
'O',
'P',
'Q',
'R',
'S',
'T',
'U',
'V',
'W',
'X',
'Y',
'Z',
'0',
'1',
'2',
'3',
'4',
'5',
'6',
'7',
'8',
'9'
],
discount: {type: 'monetary', value: 120},
discountLimit: 120,
validityDuration: '5D',
pendingDuration: '5D'
}
}
})
};
fetch('https://api.example.com/v1/campaigns/{campaignId}/loyalty', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v1/campaigns/{campaignId}/loyalty",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Clube Pedir Gás',
'description' => 'Programa de fidelidade do Clube Pedir Gás',
'defaultValidity' => '5D',
'defaultPending' => '5D',
'programJoinPolicy' => 'manualJoin',
'programExitPolicy' => 'keepPoints',
'programRedemptionPolicy' => 'automatic',
'autoRedemptionSettings' => [
'amount' => 5,
'couponSettings' => [
'pattern' => 'CLUBE-######',
'validCharacters' => [
'A',
'B',
'C',
'D',
'E',
'F',
'G',
'H',
'I',
'J',
'K',
'L',
'M',
'N',
'O',
'P',
'Q',
'R',
'S',
'T',
'U',
'V',
'W',
'X',
'Y',
'Z',
'0',
'1',
'2',
'3',
'4',
'5',
'6',
'7',
'8',
'9'
],
'discount' => [
'type' => 'monetary',
'value' => 120
],
'discountLimit' => 120,
'validityDuration' => '5D',
'pendingDuration' => '5D'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/campaigns/{campaignId}/loyalty"
payload := strings.NewReader("{\n \"name\": \"Clube Pedir Gás\",\n \"description\": \"Programa de fidelidade do Clube Pedir Gás\",\n \"defaultValidity\": \"5D\",\n \"defaultPending\": \"5D\",\n \"programJoinPolicy\": \"manualJoin\",\n \"programExitPolicy\": \"keepPoints\",\n \"programRedemptionPolicy\": \"automatic\",\n \"autoRedemptionSettings\": {\n \"amount\": 5,\n \"couponSettings\": {\n \"pattern\": \"CLUBE-######\",\n \"validCharacters\": [\n \"A\",\n \"B\",\n \"C\",\n \"D\",\n \"E\",\n \"F\",\n \"G\",\n \"H\",\n \"I\",\n \"J\",\n \"K\",\n \"L\",\n \"M\",\n \"N\",\n \"O\",\n \"P\",\n \"Q\",\n \"R\",\n \"S\",\n \"T\",\n \"U\",\n \"V\",\n \"W\",\n \"X\",\n \"Y\",\n \"Z\",\n \"0\",\n \"1\",\n \"2\",\n \"3\",\n \"4\",\n \"5\",\n \"6\",\n \"7\",\n \"8\",\n \"9\"\n ],\n \"discount\": {\n \"type\": \"monetary\",\n \"value\": 120\n },\n \"discountLimit\": 120,\n \"validityDuration\": \"5D\",\n \"pendingDuration\": \"5D\"\n }\n }\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.example.com/v1/campaigns/{campaignId}/loyalty")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Clube Pedir Gás\",\n \"description\": \"Programa de fidelidade do Clube Pedir Gás\",\n \"defaultValidity\": \"5D\",\n \"defaultPending\": \"5D\",\n \"programJoinPolicy\": \"manualJoin\",\n \"programExitPolicy\": \"keepPoints\",\n \"programRedemptionPolicy\": \"automatic\",\n \"autoRedemptionSettings\": {\n \"amount\": 5,\n \"couponSettings\": {\n \"pattern\": \"CLUBE-######\",\n \"validCharacters\": [\n \"A\",\n \"B\",\n \"C\",\n \"D\",\n \"E\",\n \"F\",\n \"G\",\n \"H\",\n \"I\",\n \"J\",\n \"K\",\n \"L\",\n \"M\",\n \"N\",\n \"O\",\n \"P\",\n \"Q\",\n \"R\",\n \"S\",\n \"T\",\n \"U\",\n \"V\",\n \"W\",\n \"X\",\n \"Y\",\n \"Z\",\n \"0\",\n \"1\",\n \"2\",\n \"3\",\n \"4\",\n \"5\",\n \"6\",\n \"7\",\n \"8\",\n \"9\"\n ],\n \"discount\": {\n \"type\": \"monetary\",\n \"value\": 120\n },\n \"discountLimit\": 120,\n \"validityDuration\": \"5D\",\n \"pendingDuration\": \"5D\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/campaigns/{campaignId}/loyalty")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Clube Pedir Gás\",\n \"description\": \"Programa de fidelidade do Clube Pedir Gás\",\n \"defaultValidity\": \"5D\",\n \"defaultPending\": \"5D\",\n \"programJoinPolicy\": \"manualJoin\",\n \"programExitPolicy\": \"keepPoints\",\n \"programRedemptionPolicy\": \"automatic\",\n \"autoRedemptionSettings\": {\n \"amount\": 5,\n \"couponSettings\": {\n \"pattern\": \"CLUBE-######\",\n \"validCharacters\": [\n \"A\",\n \"B\",\n \"C\",\n \"D\",\n \"E\",\n \"F\",\n \"G\",\n \"H\",\n \"I\",\n \"J\",\n \"K\",\n \"L\",\n \"M\",\n \"N\",\n \"O\",\n \"P\",\n \"Q\",\n \"R\",\n \"S\",\n \"T\",\n \"U\",\n \"V\",\n \"W\",\n \"X\",\n \"Y\",\n \"Z\",\n \"0\",\n \"1\",\n \"2\",\n \"3\",\n \"4\",\n \"5\",\n \"6\",\n \"7\",\n \"8\",\n \"9\"\n ],\n \"discount\": {\n \"type\": \"monetary\",\n \"value\": 120\n },\n \"discountLimit\": 120,\n \"validityDuration\": \"5D\",\n \"pendingDuration\": \"5D\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"errors": [
{
"code": "<string>",
"target": "<string>",
"message": "<string>"
}
]
}{
"errors": [
{
"code": "<string>",
"target": "<string>",
"message": "<string>"
}
]
}{
"errors": [
{
"code": "<string>",
"target": "<string>",
"message": "<string>"
}
]
}{
"errors": [
{
"code": "<string>",
"target": "<string>",
"message": "<string>"
}
]
}Loyalties
Configurar programa de fidelidade
Configura o programa de fidelidade da campanha existente com os dados informados.
PUT
/
v1
/
campaigns
/
{campaignId}
/
loyalty
Configurar programa de fidelidade
curl --request PUT \
--url https://api.example.com/v1/campaigns/{campaignId}/loyalty \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Clube Pedir Gás",
"description": "Programa de fidelidade do Clube Pedir Gás",
"defaultValidity": "5D",
"defaultPending": "5D",
"programJoinPolicy": "manualJoin",
"programExitPolicy": "keepPoints",
"programRedemptionPolicy": "automatic",
"autoRedemptionSettings": {
"amount": 5,
"couponSettings": {
"pattern": "CLUBE-######",
"validCharacters": [
"A",
"B",
"C",
"D",
"E",
"F",
"G",
"H",
"I",
"J",
"K",
"L",
"M",
"N",
"O",
"P",
"Q",
"R",
"S",
"T",
"U",
"V",
"W",
"X",
"Y",
"Z",
"0",
"1",
"2",
"3",
"4",
"5",
"6",
"7",
"8",
"9"
],
"discount": {
"type": "monetary",
"value": 120
},
"discountLimit": 120,
"validityDuration": "5D",
"pendingDuration": "5D"
}
}
}
'import requests
url = "https://api.example.com/v1/campaigns/{campaignId}/loyalty"
payload = {
"name": "Clube Pedir Gás",
"description": "Programa de fidelidade do Clube Pedir Gás",
"defaultValidity": "5D",
"defaultPending": "5D",
"programJoinPolicy": "manualJoin",
"programExitPolicy": "keepPoints",
"programRedemptionPolicy": "automatic",
"autoRedemptionSettings": {
"amount": 5,
"couponSettings": {
"pattern": "CLUBE-######",
"validCharacters": ["A", "B", "C", "D", "E", "F", "G", "H", "I", "J", "K", "L", "M", "N", "O", "P", "Q", "R", "S", "T", "U", "V", "W", "X", "Y", "Z", "0", "1", "2", "3", "4", "5", "6", "7", "8", "9"],
"discount": {
"type": "monetary",
"value": 120
},
"discountLimit": 120,
"validityDuration": "5D",
"pendingDuration": "5D"
}
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Clube Pedir Gás',
description: 'Programa de fidelidade do Clube Pedir Gás',
defaultValidity: '5D',
defaultPending: '5D',
programJoinPolicy: 'manualJoin',
programExitPolicy: 'keepPoints',
programRedemptionPolicy: 'automatic',
autoRedemptionSettings: {
amount: 5,
couponSettings: {
pattern: 'CLUBE-######',
validCharacters: [
'A',
'B',
'C',
'D',
'E',
'F',
'G',
'H',
'I',
'J',
'K',
'L',
'M',
'N',
'O',
'P',
'Q',
'R',
'S',
'T',
'U',
'V',
'W',
'X',
'Y',
'Z',
'0',
'1',
'2',
'3',
'4',
'5',
'6',
'7',
'8',
'9'
],
discount: {type: 'monetary', value: 120},
discountLimit: 120,
validityDuration: '5D',
pendingDuration: '5D'
}
}
})
};
fetch('https://api.example.com/v1/campaigns/{campaignId}/loyalty', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v1/campaigns/{campaignId}/loyalty",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Clube Pedir Gás',
'description' => 'Programa de fidelidade do Clube Pedir Gás',
'defaultValidity' => '5D',
'defaultPending' => '5D',
'programJoinPolicy' => 'manualJoin',
'programExitPolicy' => 'keepPoints',
'programRedemptionPolicy' => 'automatic',
'autoRedemptionSettings' => [
'amount' => 5,
'couponSettings' => [
'pattern' => 'CLUBE-######',
'validCharacters' => [
'A',
'B',
'C',
'D',
'E',
'F',
'G',
'H',
'I',
'J',
'K',
'L',
'M',
'N',
'O',
'P',
'Q',
'R',
'S',
'T',
'U',
'V',
'W',
'X',
'Y',
'Z',
'0',
'1',
'2',
'3',
'4',
'5',
'6',
'7',
'8',
'9'
],
'discount' => [
'type' => 'monetary',
'value' => 120
],
'discountLimit' => 120,
'validityDuration' => '5D',
'pendingDuration' => '5D'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/campaigns/{campaignId}/loyalty"
payload := strings.NewReader("{\n \"name\": \"Clube Pedir Gás\",\n \"description\": \"Programa de fidelidade do Clube Pedir Gás\",\n \"defaultValidity\": \"5D\",\n \"defaultPending\": \"5D\",\n \"programJoinPolicy\": \"manualJoin\",\n \"programExitPolicy\": \"keepPoints\",\n \"programRedemptionPolicy\": \"automatic\",\n \"autoRedemptionSettings\": {\n \"amount\": 5,\n \"couponSettings\": {\n \"pattern\": \"CLUBE-######\",\n \"validCharacters\": [\n \"A\",\n \"B\",\n \"C\",\n \"D\",\n \"E\",\n \"F\",\n \"G\",\n \"H\",\n \"I\",\n \"J\",\n \"K\",\n \"L\",\n \"M\",\n \"N\",\n \"O\",\n \"P\",\n \"Q\",\n \"R\",\n \"S\",\n \"T\",\n \"U\",\n \"V\",\n \"W\",\n \"X\",\n \"Y\",\n \"Z\",\n \"0\",\n \"1\",\n \"2\",\n \"3\",\n \"4\",\n \"5\",\n \"6\",\n \"7\",\n \"8\",\n \"9\"\n ],\n \"discount\": {\n \"type\": \"monetary\",\n \"value\": 120\n },\n \"discountLimit\": 120,\n \"validityDuration\": \"5D\",\n \"pendingDuration\": \"5D\"\n }\n }\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.example.com/v1/campaigns/{campaignId}/loyalty")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Clube Pedir Gás\",\n \"description\": \"Programa de fidelidade do Clube Pedir Gás\",\n \"defaultValidity\": \"5D\",\n \"defaultPending\": \"5D\",\n \"programJoinPolicy\": \"manualJoin\",\n \"programExitPolicy\": \"keepPoints\",\n \"programRedemptionPolicy\": \"automatic\",\n \"autoRedemptionSettings\": {\n \"amount\": 5,\n \"couponSettings\": {\n \"pattern\": \"CLUBE-######\",\n \"validCharacters\": [\n \"A\",\n \"B\",\n \"C\",\n \"D\",\n \"E\",\n \"F\",\n \"G\",\n \"H\",\n \"I\",\n \"J\",\n \"K\",\n \"L\",\n \"M\",\n \"N\",\n \"O\",\n \"P\",\n \"Q\",\n \"R\",\n \"S\",\n \"T\",\n \"U\",\n \"V\",\n \"W\",\n \"X\",\n \"Y\",\n \"Z\",\n \"0\",\n \"1\",\n \"2\",\n \"3\",\n \"4\",\n \"5\",\n \"6\",\n \"7\",\n \"8\",\n \"9\"\n ],\n \"discount\": {\n \"type\": \"monetary\",\n \"value\": 120\n },\n \"discountLimit\": 120,\n \"validityDuration\": \"5D\",\n \"pendingDuration\": \"5D\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/campaigns/{campaignId}/loyalty")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Clube Pedir Gás\",\n \"description\": \"Programa de fidelidade do Clube Pedir Gás\",\n \"defaultValidity\": \"5D\",\n \"defaultPending\": \"5D\",\n \"programJoinPolicy\": \"manualJoin\",\n \"programExitPolicy\": \"keepPoints\",\n \"programRedemptionPolicy\": \"automatic\",\n \"autoRedemptionSettings\": {\n \"amount\": 5,\n \"couponSettings\": {\n \"pattern\": \"CLUBE-######\",\n \"validCharacters\": [\n \"A\",\n \"B\",\n \"C\",\n \"D\",\n \"E\",\n \"F\",\n \"G\",\n \"H\",\n \"I\",\n \"J\",\n \"K\",\n \"L\",\n \"M\",\n \"N\",\n \"O\",\n \"P\",\n \"Q\",\n \"R\",\n \"S\",\n \"T\",\n \"U\",\n \"V\",\n \"W\",\n \"X\",\n \"Y\",\n \"Z\",\n \"0\",\n \"1\",\n \"2\",\n \"3\",\n \"4\",\n \"5\",\n \"6\",\n \"7\",\n \"8\",\n \"9\"\n ],\n \"discount\": {\n \"type\": \"monetary\",\n \"value\": 120\n },\n \"discountLimit\": 120,\n \"validityDuration\": \"5D\",\n \"pendingDuration\": \"5D\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"errors": [
{
"code": "<string>",
"target": "<string>",
"message": "<string>"
}
]
}{
"errors": [
{
"code": "<string>",
"target": "<string>",
"message": "<string>"
}
]
}{
"errors": [
{
"code": "<string>",
"target": "<string>",
"message": "<string>"
}
]
}{
"errors": [
{
"code": "<string>",
"target": "<string>",
"message": "<string>"
}
]
}Parâmetros de caminho
Identificador da campanha
Corpo
application/json
Dados de configuração
Nome do programa de fidelidade
Exemplo:
"Clube Pedir Gás"
Descrição do programa de fidelidade
Exemplo:
"Programa de fidelidade do Clube Pedir Gás"
A duração padrão após a qual os novos pontos de fidelidade devem expirar
O formato de tempo é um inteiro seguido por uma letra indicando a unidade de tempo.
Unidades disponíveis:
s: segundosm: minutosh: horasD: diasW: semanasM: mesesY: anos
Exemplo:
"5D"
A duração padrão do tempo pendente após o qual os pontos devem ser válidos
O formato de tempo é um inteiro seguido por uma letra indicando a unidade de tempo.
Unidades disponíveis:
s: segundosm: minutosh: horasD: diasW: semanasM: mesesY: anos
Exemplo:
"5D"
A política que define quando o cliente se junta ao programa de fidelidade
Opções disponíveis:
none, manualJoin Exemplo:
"manualJoin"
A política que define quando o cliente sai do programa de fidelidade
Opções disponíveis:
none, keepPoints, erasePoints Exemplo:
"keepPoints"
A política que define como será o resgate do programa de fidelidade
Opções disponíveis:
none, manual, automatic Exemplo:
"automatic"
Configurações de resgate automático
Show child attributes
Show child attributes
Resposta
No Content
Esta página foi útil?
⌘I