Campanhas API
Documentação técnica: API para Campanhas
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 | String |
Hostname | apigw.wavy.global |
Porta | 443 (https) |
Protocolo | HTTPS (TLS encryption) |
Autenticação | username + token |
Encoding | UTF-8 |
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/campaignsCampo | 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
HEADERS:
page-number: 1
per-page: 10
total: 2
total-pages: 1
{
"status": {
"error": false
},
"campaigns": [
{
"name": "My first campaign",
"id": 1,
"alias": "first"
},
{
"name": "My second campaign",
"id": 2,
"alias": "second"
}
]
}
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}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* Campo obrigatório
Campo | Detalhes | Tipo |
name* | Nome da campanha | String |
alias | Identificador da campanha para utilização na API | String |
Chamado
{
"campaign" : {
"name": "My Campaign2019",
"alias": "mycampaign2019"
}
}
Resposta
{
"status": {
"error": false
},
"campaign": {
"name": "My Campaign",
"id": 1234,
"alias": "mycampaign"
}
}
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
* Campo obrigatório
Campo | Detalhes | Tipo |
name* | Nome da campanha | String |
alias | Identificador da campanha para utilização na API | String |
Chamado
{
"campaign" : {
"name": "My Campaign",
"alias": "mycampaign"
}
}
Resposta
{
"status": {
"error": false
},
"campaign": {
"name": "My Campaign",
"id": 1234,
"alias": "mycampaign"
}
}
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
Last modified 1mo ago