Créditos e Limites
GETTING STARTED - MENU
Componentes Status Page
Campanhas API
Documentação técnica: API para Campanhas

Autenticação

A autenticação para consultas via API tem um formato padrão e é preciso apresentar um username válido (e-mail), e o token de autenticação (veja como acessar os seus dados). É necessário adicionar os seguintes headers à requisição:
Campo
Detalhes
Data Type
UserName
E-mail válido para autenticação no ChatClub.
String
AutenticaçãoToken
Token de autenticação gerado por nossa plataforma. Encontre aqui ou consulte nosso suporte. here
String

Detalhes de conexão

Hostname
apigw.wavy.global
Porta
443 (https)
Protocolo
HTTPS (TLS encryption)
Autenticação
username + token
Encoding
UTF-8

Listar campanhas

Listagem das campanhas já cadastradas na plataforma. É possível paginar os resultados ou filtrar pelo nome da campanha.
GET https://apigw.wavy.global/api/v1/campaigns

Parâmetros da QueryString

* Campo obrigatório
Campo
Detalhes
Tipo
name
Nome de uma campanha como filtro para a listagem
String
page
Página a ser listada
Integer
page_size
Total de campanhas por página
Integer
Resposta positiva
1
HEADERS:
2
page-number: 1
3
per-page: 10
4
total: 2
5
total-pages: 1
Copied!

Informando o total de campanhas que tem e Exibindo logo abaixo:

1
{
2
"status": {
3
"error": false
4
},
5
"campaigns": [
6
{
7
"name": "My first campaign",
8
"id": 1,
9
"alias": "first"
10
},
11
{
12
"name": "My second campaign",
13
"id": 2,
14
"alias": "second"
15
}
16
]
17
}
Copied!

Demonstrando

Buscar uma campanha

Busca os dados de uma campanha pelo ID de cadastro
É necessário conhecer anteriormente o ID de cadastro
GET https://apigw.wavy.global/api/v1/campaign/{id}

Criar campanha

Exemplo de criação de uma campanha:
Criação de uma nova campanha com nome e alias. O alias da campanha deve ser um nome simple para facilitar o uso com a API. Recomenda-se que seja curto e não utilize caracteres especiais.
POST https://apigw.wavy.global/api/v1/campaigns

Parâmetros do JSON

* Campo obrigatório
Campo
Detalhes
Tipo
name*
Nome da campanha
String
alias
Identificador da campanha para utilização na API
String
Chamado
1
{
2
"campaign" : {
3
"name": "My Campaign2019",
4
"alias": "mycampaign2019"
5
}
6
}
Copied!
Resposta
1
{
2
"status": {
3
"error": false
4
},
5
"campaign": {
6
"name": "My Campaign",
7
"id": 1234,
8
"alias": "mycampaign"
9
}
10
}
Copied!

Alterar campanha

Alteração de uma campanha podendo modificar o nome e/ou o alias.
PUT https://apigw.wavy.global/api/v1/campaigns/{id}
É necessário incluir o {id} da campanha que deseja realizar uma alteração

Parâmetros do JSON

* Campo obrigatório
Campo
Detalhes
Tipo
name*
Nome da campanha
String
alias
Identificador da campanha para utilização na API
String
Chamado
1
{
2
"campaign" : {
3
"name": "My Campaign",
4
"alias": "mycampaign"
5
}
6
}
Copied!
Resposta
1
{
2
"status": {
3
"error": false
4
},
5
"campaign": {
6
"name": "My Campaign",
7
"id": 1234,
8
"alias": "mycampaign"
9
}
10
}
Copied!

Excluir campanha

Exclusão de uma campanha pelo ID.
DELETE https://apigw.wavy.global/api/v1/campaigns/{id}
É necessário incluir o {id} da campanha que deseja realizar uma alteração