Gerar URL - Campanhas

Endpoint para geração de URL.

Atenção: "appId" e "secret" devem ser solicitados para a Crmall.

Requisição

Parâmetros Bodyapplication/json

environment

enum<string>

requerido

Valores permitidos:

productionstage

appId

string

requerido

Exemplo:

00000000000000

secret

string

requerido

Exemplo:

aaaaaaaaaabbbbbbbbbb00000000001111111111

testMode

boolean

requerido

Padrão:

false

appName

string

requerido

Exemplo:

Prizor SDK

appLogo

string

opcional

Exemplo:

https://maven.prizor.com/assets/logo.svg

appBrand

string

opcional

Exemplo:

https://maven.prizor.com/assets/brand.svg

accentColor

string

requerido

Exemplo:

#F1BF3B

accentForegroundColor

string

requerido

Accent contrast color (used to write on accent color backgrounds)

Exemplo:

#FFFFFF

splashForegroundColor

string

requerido

If it is empty, accentColor will be used

splashBackgroundColor

string

requerido

if it is empty, accentForegroundColor will be used

loyalty

object

requerido

loyaltyId

string

requerido

REQUIRED if [personLoyaltyId] is not null

Exemplo:

0aa0A000000AaaABC

personLoyaltyId

string

requerido

REQUIRED if [loyaltyId] is not null

Exemplo:

a0000000-0000-0000-0000-000000000000

campaignFilters

object

opcional

Enable campaign filters

exclusiveFilters

array[string]

opcional

Enable filters by exclusive filters

Valores permitidos:

GoldSilverCoper

ids

array[string]

opcional

user

object

requerido

name

string

requerido

Exemplo:

João da Silva

documentNumber

string

requerido

CPF number without special chars

Exemplo:

00618242082

cellphone

string

requerido

Confirmed cellphone number

Exemplo:

+554432186300

otherDocument

string

opcional

Other documment associated with user

gender

enum<integer>

opcional

Valores permitidos:

123

maritalStatus

enum<integer>

opcional

Valores permitidos:

12345

day

integer

opcional

Birth day

month

integer

opcional

Birth month

year

integer

opcional

Year of birth

occupation

string

opcional

phones

array [object {2}]

requerido

Alternative phones to receive notifications (do not need to re-enter the phone already informed in CELLPHONE)

emails

array [object {2}]

requerido

User e-mails to receive notifications

markers

array [object {3}]

opcional

addresses

array [object {12}]

opcional

sac

object

opcional

title

string

requerido

Customizable title for the pop-up

Exemplo:

Precisa de Ajuda?

content

string

requerido

Content who will show for the pop-up

Exemplo:

Segunda a sábado: 10h às 22h\nDomingos e Feriados: 14h às 20h

string

requerido

phone1

string

requerido

Phone in case of user want to call

Exemplo:

+554432186300

phone1Caption

string

requerido

Phone in case of user want to call

Exemplo:

(44) 3218-6300

phone2

string

requerido

What's app number in a link

Exemplo:

https://wa.me/554432186300

Exemplo

{
    "environment": "production",
    "appId": "00000000000000",
    "secret": "aaaaaaaaaabbbbbbbbbb00000000001111111111",
    "testMode": false,
    "appName": "Prizor SDK",
    "appLogo": "https://maven.prizor.com/assets/logo.svg",
    "appBrand": "https://maven.prizor.com/assets/brand.svg",
    "accentColor": "#F1BF3B",
    "accentForegroundColor": "#FFFFFF",
    "splashForegroundColor": "string",
    "splashBackgroundColor": "string",
    "loyalty": {
        "loyaltyId": "0aa0A000000AaaABC",
        "personLoyaltyId": "a0000000-0000-0000-0000-000000000000"
    },
    "campaignFilters": {
        "exclusiveFilters": [
            "Gold"
        ],
        "ids": [
            "9999"
        ]
    },
    "user": {
        "name": "João da Silva",
        "documentNumber": "00618242082",
        "cellphone": "+554432186300",
        "otherDocument": "string",
        "gender": 1,
        "maritalStatus": 1,
        "day": 0,
        "month": 0,
        "year": 0,
        "occupation": "string",
        "phones": [
            {
                "phoneNumber": "+556137693357",
                "isOptIn": true
            }
        ],
        "emails": [
            {
                "email": "string",
                "isOptIn": true
            }
        ],
        "markers": [
            {
                "categoryName": "Clube de vantagens",
                "markerName": "Gold",
                "referenceDate": "2024-08-29T11:26:44.297"
            }
        ],
        "addresses": [
            {
                "isOptIn": true,
                "zipCode": "87013-210",
                "country": "Brasil",
                "state": "PR",
                "stateName": "Paraná",
                "city": "Maringá",
                "address": "Avenida Tamandaré",
                "number": "100",
                "neighborhood": "Zona 01",
                "complement": "Sobreloja",
                "latitude": "-23.4193376",
                "longitude": "-51.9336084"
            }
        ]
    },
    "sac": {
        "title": "Precisa de Ajuda?",
        "content": "Segunda a sábado: 10h às 22h\\nDomingos e Feriados: 14h às 20h",
        "email": "string",
        "phone1": "+554432186300",
        "phone1Caption": "(44) 3218-6300",
        "phone2": "https://wa.me/554432186300"
    }
}

Exemplos de Requisição

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://campanhas.crmall.com/api/v4/prizor-web-sdk/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "environment": "production",
    "appId": "00000000000000",
    "secret": "aaaaaaaaaabbbbbbbbbb00000000001111111111",
    "testMode": false,
    "appName": "Prizor SDK",
    "appLogo": "https://maven.prizor.com/assets/logo.svg",
    "appBrand": "https://maven.prizor.com/assets/brand.svg",
    "accentColor": "#F1BF3B",
    "accentForegroundColor": "#FFFFFF",
    "splashForegroundColor": "string",
    "splashBackgroundColor": "string",
    "loyalty": {
        "loyaltyId": "0aa0A000000AaaABC",
        "personLoyaltyId": "a0000000-0000-0000-0000-000000000000"
    },
    "campaignFilters": {
        "exclusiveFilters": [
            "Gold"
        ],
        "ids": [
            "9999"
        ]
    },
    "user": {
        "name": "João da Silva",
        "documentNumber": "00618242082",
        "cellphone": "+554432186300",
        "otherDocument": "string",
        "gender": 1,
        "maritalStatus": 1,
        "day": 0,
        "month": 0,
        "year": 0,
        "occupation": "string",
        "phones": [
            {
                "phoneNumber": "+556137693357",
                "isOptIn": true
            }
        ],
        "emails": [
            {
                "email": "string",
                "isOptIn": true
            }
        ],
        "markers": [
            {
                "categoryName": "Clube de vantagens",
                "markerName": "Gold",
                "referenceDate": "2024-08-29T11:26:44.297"
            }
        ],
        "addresses": [
            {
                "isOptIn": true,
                "zipCode": "87013-210",
                "country": "Brasil",
                "state": "PR",
                "stateName": "Paraná",
                "city": "Maringá",
                "address": "Avenida Tamandaré",
                "number": "100",
                "neighborhood": "Zona 01",
                "complement": "Sobreloja",
                "latitude": "-23.4193376",
                "longitude": "-51.9336084"
            }
        ]
    },
    "sac": {
        "title": "Precisa de Ajuda?",
        "content": "Segunda a sábado: 10h às 22h\\nDomingos e Feriados: 14h às 20h",
        "email": "string",
        "phone1": "+554432186300",
        "phone1Caption": "(44) 3218-6300",
        "phone2": "https://wa.me/554432186300"
    }
}'

Respostas

🟢200Success

application/json

Body

string

opcional

Exemplo

{
    "status": "success",
    "code": 200,
    "message": "",
    "error": null,
    "data": {
        "uri": "https://static-sdk.prizor.com/latest/#/splash?token=LHJG6VHpk80rDlhOg0uyW9RljTovL9DgbhGXSe6PdkruNmo3wVkEZIfdMMPZFU83ceQDAogQMdrYjHvZysKZ1GWQKYo33hkPskagU6ngKD6RMdpI9CFuz3cttUMHJjAyIzMrElhim1ZxBZSACtuqv5HTaTjrKV4otjFahLBGkmhvRfwQ8Bnp9uqtWaYXqP2nsQnxqYoqLSgrRukE7UG8k0W1LpnK7ItLzeqIzSA0vx92qnnn8W5TWavr9ufgolUasj5QMdlrbomNiish0KhEIIGIcfkjkxhhz2qUjzPeu9IXkLRHWy8f1ccDIYIVp3kgm50XRfQY5i5BqjWx8VLal9FY9AUqu2vxMPN0CoeEWVa9EQrR2YTBhbnuPT4tsPq8OZvH5fr7utfZzT3fJGiMgmY594Dg3AGwt1GQFEUyHVvxuUmyR2iETvfbZ2MDmLVTm0kk1PWEvWZueUUKX0ZICR76Prpxlpdf3IpZq7HM4joBqYfmOGbCzv2eCYFKtj1JUponRXxtNytU3oCuLvWNLoiUJGEJUGq4TYGOETqRPrSLUmUu0AASOlA6fs9AN24A2DmeaVOxEEtfftxtRCaOrPUDh11UXmjaGkHK0HpZ93Wxb67bHoxFCqAEgh8yAoXtVZ9VtdBefoYfMtn5klyZuNP7n9gDHHxlBpyPvj3Ako8929netHbfpjMKaQwcSUTjxoRVFjkeYcmpXtFjZ3hPFtJ8ePuF3BMUL2Y7c8IEiD69thweCKlyfOxHI5SadVQpsHGUj3P2nt7QeMy3OSf2Z4ofl1Vfe6xXUhVQp8skzDU5pFLMxdHqiJ9peQHjoUHZSKeFJ9uibABxZT6s6e4IK3pKY9UxDfPcrEcMpY22w3exuR9CLbUzOEcRIZX3Rvc25OG335pbI4pH4T2r7ikp8L9xhFtYAV2yzmrSjXnLkaJPuhtzBLwe3UgOv1HsLn9f3iGnHvqNh5yLKu6Lfv48xErXowb2hRgRjoHYDcm6GSrLlTnXh3nX2KjJCCg2aePItpm0viBgpHLrA9vhrdFlpDRwOvm2ea7GoycCJvghJ1kEGYTyl0sZfOfb7kqELTmGG18cUPp5DqE5RApJnGRa5tnBYidLGbNAVSWrgtShm7ZbN9Fg5YvbUIlS0mt4TMuxhzjyymrPIKUEDcSqme0bdf4XyNXGx8QqOnjgxLzFqmiZN8Fx8rvddA4e3npR80YcDULl4cTH3882qXbwqx5L7th43ji9OXvWcZp5234o4aUFZhW5eKOa32wxfZ7U1B0ndfwphOFVSNTpxN0Ds5By4LktDnDwgm0KNAHHWFxAyglVpuS5hiNr17VfTh4lcYx2XUCQrr3XhP5e2kH7JPMtysRSoyKckDhN6BdH2rA0d9wGy7o5MdsVdI5QGG5n5pl68LoBD7zOQ4zAm6MfcrQa57aBGE0lCU4X2zGYLlUcpAGar0RRDiNH1Fpk8VvBmGZCzIWCMrKc5zSiWqhMcK2n3Qh8Ku3CTQyzmLb2uKZ9w1kxjlZ5aqgTPgLUX9HdLmcKTxldLmYhXW53nGSKZmM0lbpc1cKvhvfoCgqmVPvT8tmv01OBqk6gjrjcz8wcR0V7uQ0yQB54ZsTIXiqJ7tPqJWqNVGGms355s0WEIvMRtk9N4hcxW5R8XwnFo3W11P6VVs29XeDuJ63uLdfgAffmoM4dc8g9VimTAwuWgQIABvrzVBDPcwTvSkvo1RAxJL7X"
    }
}