API
Consulta los detalles de la API en la Documentación Swagger
La referencia interactiva de todos los endpoints está en la Documentación Swagger del NicoChat. Son 247 operaciones en 230 endpoints, agrupadas en 25 áreas del producto.
También puedes importar la ¡Colección de Postman haciendo clic aquí!
La API del NicoChat se usa para recuperar datos del flujo que construyes. Estos son algunos ejemplos de lo que puedes hacer con ella.
- Extrae de NicoChat el flujo que construiste.
- Crea, elimina u obtén datos, incluyendo etiqueta de flujo y campo de flujo.
- Trabaja con los datos de los suscriptores: obtén la información del suscriptor y edita su etiqueta o campo, así como el subflujo enviado a él.
- Configura todos los datos utilizados en el e-commerce, como carritos o productos.
Si necesitas trabajar con los datos a continuación, las próximas secciones presentan los pasos para usar la API del NicoChat.
Toda llamada sale de la URL base https://app.nicochat.com/api, se autentica con Bearer más tu clave de API y responde en JSON. Cada grupo exige un alcance en la clave — Manage Flow, Manage Team o Send Message —, indicado en la descripción del endpoint en Swagger.
Como la protección de los datos es importante para la API, esta necesita varios atributos para autorizar tu identidad. Por eso, el primer paso es ingresar la información de autorización. Haz clic en el botón Authorize, como se muestra en la figura a continuación.
A continuación, hay tres atributos que debes completar en el cuadro de texto.
Consulta en la sección siguiente cómo encontrar estos atributos.
Paso 1. Después de entrar en tu cuenta del NicoChat, el nombre de la cuenta y el avatar aparecen en la esquina superior derecha. Haz clic en ellos y elige Tus Configuraciones en la lista desplegable.
Paso 2. Ve a la sección Tokens API haciendo clic en el botón en la configuración del usuario. Escribe el nombre de la clave que quieres definir y haz clic en el botón Crear.
Paso 3. Recibirás la clave en una ventana emergente.
Cierra la ventana y obtendrás la información básica sobre la clave, excepto el valor de la clave.
El curl se usa en las solicitudes de API. En la documentación de la API del NicoChat, debes realizar algunas operaciones antes de obtenerlo.
Aquí usamos Get Flow Tag como ejemplo.
Paso 1. Haz clic para expandir la categoría, en este caso Flow Tag. Luego encuentra la acción y el recurso Get /flow/tags. Haz clic en la fila y se mostrará una página desplegable, como se ve a continuación.
Paso 2. Este ícono significa autorizar. Si ya lo hiciste antes, este paso no es necesario. De lo contrario, repite lo que se describió en la sección Autorizar.
Paso 3. Haz clic en Try it out. Luego verás que la parte Parámetros o Cuerpo de la solicitud se puede completar y que el botón Execute aparece en la parte inferior de esa área.
Paso 4. Ingresa los parámetros o el cuerpo de la solicitud necesarios y haz clic en el botón Execute. Por último, obtendrás el Curl y la URL de Solicitud.
Esta parte muestra el resultado JSON que obtendrás de la API del NicoChat. Normalmente, si el código es 200, significa que obtuviste la respuesta con éxito. Si el código es 400, significa que hay un error en tu respuesta.
Además del valor de ejemplo, puedes hacer clic en “Esquema” para ver más detalles, como qué valor es obligatorio.
