Listar conjuntos de regras
curl --request GET \
--url https://api.example.com/v1/campaigns/{campaignId}/rulesets \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.example.com/v1/campaigns/{campaignId}/rulesets"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.example.com/v1/campaigns/{campaignId}/rulesets', 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}/rulesets",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/campaigns/{campaignId}/rulesets"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/v1/campaigns/{campaignId}/rulesets")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/campaigns/{campaignId}/rulesets")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"rules": [
{
"name": "Dealer",
"description": "Validação da revenda",
"parameters": {
"dealers": [
"9052d465-cbeb-4527-afcd-ea944a6c74a6"
]
},
"operator": "and",
"conditions": [
{
"type": "<string>",
"operator": "<string>"
}
],
"effects": [
{
"name": "rejectCouponDealer",
"description": "Rejeita cupons de outras revendas",
"type": "rejectCoupon",
"parameters": {
"reason": "O cupom é inválido para esta revenda"
}
}
]
}
],
"tags": [
"primeira compra"
],
"state": "enabled",
"campaign": {
"id": "de571341-28ea-48bb-8dcb-e32372db8606",
"state": "enabled",
"startAt": "2024-06-05T09:00:00-03:00",
"endAt": "2030-06-05T23:59:59-03:00"
},
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "Regra de primeira compra",
"activatedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"modifiedAt": "2023-11-07T05:31:56Z"
}
],
"pagination": {
"limit": 123,
"offset": 123,
"keyset": "<string>",
"count": 123,
"totalCount": 123
}
}{
"errors": [
{
"code": "<string>",
"target": "<string>",
"message": "<string>"
}
]
}{
"errors": [
{
"code": "<string>",
"target": "<string>",
"message": "<string>"
}
]
}Rulesets
Listar conjuntos de regras
Lista os conjuntos de regras aplicando os filtros informados.
GET
/
v1
/
campaigns
/
{campaignId}
/
rulesets
Listar conjuntos de regras
curl --request GET \
--url https://api.example.com/v1/campaigns/{campaignId}/rulesets \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.example.com/v1/campaigns/{campaignId}/rulesets"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.example.com/v1/campaigns/{campaignId}/rulesets', 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}/rulesets",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/campaigns/{campaignId}/rulesets"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/v1/campaigns/{campaignId}/rulesets")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/campaigns/{campaignId}/rulesets")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"rules": [
{
"name": "Dealer",
"description": "Validação da revenda",
"parameters": {
"dealers": [
"9052d465-cbeb-4527-afcd-ea944a6c74a6"
]
},
"operator": "and",
"conditions": [
{
"type": "<string>",
"operator": "<string>"
}
],
"effects": [
{
"name": "rejectCouponDealer",
"description": "Rejeita cupons de outras revendas",
"type": "rejectCoupon",
"parameters": {
"reason": "O cupom é inválido para esta revenda"
}
}
]
}
],
"tags": [
"primeira compra"
],
"state": "enabled",
"campaign": {
"id": "de571341-28ea-48bb-8dcb-e32372db8606",
"state": "enabled",
"startAt": "2024-06-05T09:00:00-03:00",
"endAt": "2030-06-05T23:59:59-03:00"
},
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "Regra de primeira compra",
"activatedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"modifiedAt": "2023-11-07T05:31:56Z"
}
],
"pagination": {
"limit": 123,
"offset": 123,
"keyset": "<string>",
"count": 123,
"totalCount": 123
}
}{
"errors": [
{
"code": "<string>",
"target": "<string>",
"message": "<string>"
}
]
}{
"errors": [
{
"code": "<string>",
"target": "<string>",
"message": "<string>"
}
]
}Parâmetros de caminho
Identificador da campanha
Parâmetros de consulta
Número de registros a serem retornados
Exemplo:
50
Número do começo de registros a serem retornados.
Nota: Limitado a 10.000 registros. Recomendamos a utilização do keyset para paginação continua.
Exemplo:
0
Identificador usado para paginação baseada em cursor.
Nota: Somente será considerado caso o valor do campo offset seja 0.
Exemplo:
"cGl0OmJXRnBibDlwYm1SbGVDNXdjbWx0WVhKNTpbMTcwMDAwMDAwMDAwMF0="
Termo da pesquisa
Exemplo:
"Primeira compra"
Filtra pelos estados do conjunto de regras
Opções disponíveis:
enabled, disabled Exemplo:
["enabled"]
Filtra pelas tags do conjunto de regras
Exemplo:
["primeira compra"]
Esta página foi útil?
⌘I