📌 Una vez obtenido el token de acceso ya puedes registrar interacciones de tus clientes en RAY a través de la API.

Servicio

La información debe registrarse por medio de este servicio:

POST https://api.rayapp.io/events/interaction

Estructura del mensaje de entrada

Estructura general

Como entrada, se acepta una lista de eventos, donde cada evento tiene información del cliente asociado.

[

{

"customProps": {

<ver detalle para cada tipo de evento particular>

},

"storeId": <storeId>,

"subType": "<subtype>",

"type": "<type>",

"source": "OTHER",

"timestamp": "2020-08-05T18:38:13.343Z",

"user": {

"email": "string",

"phone": "string",

"name": "string",

"lastName": "string",

"gender": "string",

"birthDate": "2020-08-05T18:38:13.344Z",

"googleProfile": "string",

"instagramProfile": "string",

"linkedInProfile": "string",

"facebookProfile": "string",

"twitterProfile": "string"

}

}

]

Los campos marcados en negrita son obligatorios

customProps

Depende del tipo de evento. Ver sección de cada evento particular

type y subtype

Depende del tipo de evento. Ver sección de cada evento particular

source

Siempre enviar valor OTHER

storeId

Id de la tienda donde debe registrarse el usuario y el evento

timestamp

Fecha y hora en que ocurrió el evento

user.email

Email del usuario

(*) es obligatorio si no se envía user.phone

user.phone

Teléfono del usuario

(*) es obligatorio si no se envía user.email

user.name

Nombre del usuario

user.lastName

Apellido del usuario

user.gender

M: masculino
F: femenino

O: otros

user.birthDate

Fecha de nacimiento del cliente

user.country

País del cliente según el estándar ISO 3166-1-alpha-2 (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)

instagramProfile

URL del perfil del usuario en instagram

linkedInProfile

URL del perfil del usuario en linkedin

facebookProfile

URL del perfil del usuario en facebook

twitterProfile

URL del perfil del usuario en twitter

googleProfile

URL del perfil del usuario en google

💡 Datos particulares según las interacciones que se desean comunicar

Estructura del mensaje de respuesta

Un código de retorno 200 indica operación exitosa. En caso haber errores de validación o de permisos se indicarán en el campo message y el statusCode será distinto a 200.

{

"message": "string",

"result": "success",

"statusCode": 200

}

En caso de no disponibilidad de servicio o errores de conectividad, pueden realizarse reintentos del lado aplicación cliente.


Artículos relacionados

Cómo: autenticarse para utilizar la API

Visita nuestro Help Center, allí encontrarás más información para continuar aprendiendo sobre la plataforma.


¿Qué te pareció este artículo? 👇

¿Encontró su respuesta?