API

Introducción a las APIs

La API de OneChat se utiliza para recuperar datos del flujo que construyes. Aquí tienes algunos ejemplos de lo que puedes hacer con la API de OneChat.

• Obtener el flujo que has creado en OneChat.

• Crear, eliminar u obtener datos, incluidos la etiqueta del flujo y el campo del flujo.

• Gestionar los datos de los suscriptores, incluyendo obtener la información de los suscriptores, editar su etiqueta o campo, así como el subflujo enviado a los suscriptores.

• Configurar todos los datos utilizados en e-commerce, como carritos o productos.

Si necesitas trabajar con los datos mencionados arriba, en las siguientes secciones se presentarán los pasos para usar la API de OneChat.

Autorización

Dado que la protección de los datos es importante para la API, es necesario usar varios atributos para autorizar tu identidad. Por lo tanto, el primer paso que debes realizar es ingresar la información de autorización. Debes hacer clic en el botón Authorize, como se muestra en la siguiente imagen.

Luego, hay tres atributos que debes completar en el cuadro de texto.

En la siguiente sección se explica cómo encontrar estos atributos.

Generar API Key (http,Bearer)

Paso 1. Después de iniciar sesión en tu cuenta de OneChat, en la esquina superior derecha aparecerán el nombre de tu cuenta y tu avatar. Haz clic allí y elige Your Settings en la lista desplegable.

Paso 2. Ve a la sección API Keys haciendo clic en el botón dentro de User Setting. Ingresa el nombre de la clave que deseas establecer y haz clic en el botón Create.

Paso 3. Luego obtendrás la clave en una ventana emergente.

WARNING - Aquí está tu nueva API Key. ¡Esta es la única vez que se mostrará la clave, así que asegúrate de no perderla! Puedes revocar la clave en cualquier momento desde la configuración de tu API.

Al cerrar la ventana, obtendrás la información básica sobre la clave, excepto el valor de la clave.

Obtener el Curl y la Request URL

Curl se utiliza en las solicitudes de API. En la documentación de la API de OneChat, necesitas realizar algunas acciones antes de obtener el curl en la documentación de la API de OneChat.

Aquí usamos Get Flow Tag como ejemplo.

Paso 1. Haz clic en la operación de expansión de la categoría, en este caso Flow Tag. Luego busca la acción y la función, Get /flow/tags. Haz clic en la fila y se desplegará una página como se muestra a continuación.

Paso 2. Este ícono significa autorización. Si ya lo has hecho antes, este paso no es necesario. De lo contrario, simplemente haz lo mismo que se mencionó anteriormente en la sección Authorize.

Paso 3. Haz clic en Try it out. Luego verás que la parte de Parameters o Request body se podrá completar y el botón Exexute aparecerá en la parte inferior de esta sección.

Paso 4. Ingresa los parámetros o el cuerpo de la solicitud requeridos y haz clic en el botón Exexute. Finalmente obtendrás el Curl y la Request URL.

TIP - Haz clic en el botón Clear si necesitas restablecer los parámetros.

Responses

Esta parte muestra el resultado Json que obtendrás de la API de OneChat. Normalmente, si el código es 200, significa que obtuviste la respuesta correctamente. Si el código es 400, significa que hay un error en tu respuesta.

Example Value / Schema

Además del valor de ejemplo, puedes hacer clic en "Schema" para ver más detalles, como qué valor es obligatorio.

API oficial de OneChat

Puedes encontrar más información sobre la API de OneChat aquí.

API para partners de OneChat

Si te uniste al plan de partners de OneChat, entonces puedes obtener más información sobre la API para partners de OneChat.