Campañas API
Este documento proporciona la información necesaria para integrarse con la plataforma de ChatClub para realizar la gestión de campañas. La API tiene integración REST, mediante el protocolo HTTP con TLS, que admite los métodos POST con los parámetros enviados en formato JSON.

Autenticación

Para utilizar con éxito nuestra API, debe proporcionar un nombre de usuario válido (correo electrónico) asociado con un token de autenticación. Debe agregar los siguientes encabezados a la solicitud:
Campo
Detalles
Tipo de datos
userName
Correo electrónico válido suscrito en la plataforma ChatClub
String
authenticationToken
Token de autenticación generado por nuestra plataforma. Encuéntrelo aquí o consulte nuestro soporte. here
String

Detalles de conexión

Hostname
apigw.wavy.global
Port
443 (https)
Protocol
HTTPS (TLS encryption)
Authorization
username + token
Encoding
UTF-8

Listado de campañas

Ejemplo de listado de campañas
1
curl -X GET \
2
'https://apigw.wavy.global/api/v1/campaigns?name=MyCampaign&page=1&page_size=10' \
3
-H 'Content-Type: application/json' \
4
-H 'authenticationToken: <authentication_token>' \
5
-H 'userName: <e-mail>'
6
Copied!
Respuesta
1
HEADERS:
2
page-number: 1
3
per-page: 10
4
total: 2
5
total-pages: 1
Copied!
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!
Listado de campañas ya registradas en la plataforma. Puedes seleccionar la página de resultados o filtrar por nombre de campaña. GET https://apigw.wavy.global/api/v1/campaigns

Parámetros QueryString

* Campos Requeridos
Campo
Detalles
Tipo de Dato
name
Nombre de la campaña para ser utilizado como filtro.
String
page
Página que se solicita
Integer
page_size
Cantidad de registros por página
Integer

Solicitando una campaña específica

Ejemplo de solicitación de una campaña específica
1
curl -X GET \
2
https://apigw.wavy.global/api/v1/campaigns/1234 \
3
-H 'Content-Type: application/json' \
4
-H 'authenticationToken: <authentication_token>' \
5
-H 'userName: <e-mail>'
6
Copied!
Respuesta
1
{
2
"status": {
3
"error": false
4
},
5
"campaign": {
6
"name": "My Campaign",
7
"id": 1234,
8
"alias": "mycampaign"
9
}
10
}
Copied!
Solicitando una campaña específica por el ID
GET https://apigw.wavy.global/api/v1/campaign/{id}

Creando campañas

Ejemplo de creación de campaña:
1
curl -X POST \
2
https://apigw.wavy.global/api/v1/campaigns \
3
-H 'Content-Type: application/json' \
4
-H 'authenticationToken: <authentication_token>' \
5
-H 'userName: <e-mail>' \
6
-d '{
7
"campaign" : {
8
"name": "My Campaign",
9
"alias": "mycampaign"
10
}
11
}'
Copied!
Respuesta
1
{
2
"status": {
3
"error": false
4
},
5
"campaign": {
6
"name": "My Campaign",
7
"id": 1234,
8
"alias": "mycampaign"
9
}
10
}
Copied!
Creando una nueva campaña con nombre y alias . El alias de la campaña debe ser un nombre simple para que sea más fácil de usar con la API. Se recomienda ser corto y no usar caracteres especiales.
POST https://apigw.wavy.global/api/v1/campaigns

JSON Object

* Campos requeridos
Campo
Detalles
Tipo de dato
name*
Nombre de la campaña
String
alias
Identificador de la campaña.
String

Cambiando campañas

Ejemplo de cambio en campaña:
1
curl -X PUT \
2
https://apigw.wavy.global/api/v1/campaigns/1234 \
3
-H 'Content-Type: application/json' \
4
-H 'authenticationToken: <authentication_token>' \
5
-H 'userName: <e-mail>' \
6
-d '{
7
"campaign" : {
8
"name": "My Campaign",
9
"alias": "mycampaign"
10
}
11
}'
Copied!
Respuesta
1
{
2
"status": {
3
"error": false
4
},
5
"campaign": {
6
"name": "My Campaign",
7
"id": 1234,
8
"alias": "mycampaign"
9
}
10
}
Copied!
Cambiando una campaña por su nombre o alias.
PUT https://apigw.wavy.global/api/v1/campaigns/{id}

JSON Object

* Campos requeridos
Campo
Detalles
Tipo de dato
name*
Nombre de la campaña
String
alias
Identificador de la campaña
String

Borrando campañas

Ejemplo borrando campañas:
1
curl -X DELETE \
2
https://apigw.wavy.global/api/v1/campaigns/1234 \
3
-H 'Content-Type: application/json' \
4
-H 'authenticationToken: <authentication_token>' \
5
-H 'userName: <e-mail>'
Copied!
Respuesta
1
{
2
"status": {
3
"error": false
4
},
5
"campaign": {
6
"name": "My Campaign",
7
"id": 1234,
8
"alias": "mycampaign"
9
}
10
}
Copied!
Borrando una campaña por su ID
DELETE https://apigw.wavy.global/api/v1/campaigns/{id}
Last modified 2yr ago