Obtener datos de Google Sheet

La API para utilizar Google Sheet con app.neoagent.co proporciona la funcionalidad para obtener una hoja enviando una solicitud GET al endpoint /chat/Chatbot/GetGoogleGoolgeSheetData.

aviso

Atención: esta API es compatible solo con chatbots tradicionales y aún no es compatible con chatbots basados en plantillas.

Endpoint

URL de la Solicitud: https://app.neoagent.co/chat/Chatbot/GetGoogleGoolgeSheetData
Método: GET

Cuerpo de la Solicitud

El cuerpo de la solicitud debe contener los siguientes parámetros:

{
// cadena, obligatoria - Identificador único (ID) del chatbot
"serialNumber": "3254a9d0424c4806b9ea3d0763xxxxxx",
// array de números enteros, opcional - Lista de los ID de datos a recuperar
"ids": [
1,
2
],
// entero, opcional - Número máximo de elementos a devolver por página, el valor predeterminado es 10
"pageSize": 10,
// entero, opcional - Número de página a recuperar, el valor predeterminado es 1
"pageNumber": 1,
// booleano, opcional - Indica si los resultados deben ordenarse en orden ascendente, el valor predeterminado es true
"isASC": true
}

Parámetros

• serialNumber - cadena, obligatoria - Identificador único (ID) del chatbot
• ids - array de números enteros, opcional - Lista de los ID de datos a recuperar
• pageSize - entero, opcional - Número máximo de elementos a devolver por página, el valor predeterminado es 10
• pageNumber - entero, opcional - Número de página a recuperar, el valor predeterminado es 1
• isASC - booleano, opcional - Indica si los resultados deben ordenarse en orden ascendente, el valor predeterminado es true

Encabezados requeridos

La solicitud API debe incluir los siguientes encabezados:

• Authorization: <Your-Secret-Key> - cadena, obligatoria - La clave secreta para autenticar la solicitud API
• Content-Type: application/json - cadena, obligatoria - El tipo de contenido de la carga de la solicitud (debe ser application/json)

Ejemplos de Solicitud

JavaScript (Fetch API)

const res = await fetch('https://app.neoagent.co/chat/Chatbot/GetSource', {
  method: 'GET',
  headers: {
  "Authorization": "<Your-Secret-Key>",
  "Content-Type": "application/json"
},
  body: JSON.stringify({
  "serialNumber": "3254a9d0424c4806b9ea3d0763xxxxxx"
})
});

const data = await res.json();
console.log(data);

Python (Requests)

import requests
import json

url = 'https://app.neoagent.co/chat/Chatbot/GetSource'
headers = {
    "Authorization": "<Your-Secret-Key>",
    "Content-Type": "application/json"
}
data = {
  "serialNumber": "3254a9d0424c4806b9ea3d0763xxxxxx"
}

response = requests.get(url, headers=headers, json=data)
data = response.json()
print(data)

cURL

curl 'https://app.neoagent.co/chat/Chatbot/GetSource' \
  -X GET \
  -H 'Authorization: <Your-Secret-Key>' \
  -H 'Content-Type: application/json' \
  -d '{"serialNumber":"3254a9d0424c4806b9ea3d0763xxxxxx"}'

HTTP Raw

GET /chat/Chatbot/GetSource HTTP/1.1
Host: app.neoagent.co
Authorization: <Your-Secret-Key>
Content-Type: application/json

{
  "serialNumber": "3254a9d0424c4806b9ea3d0763xxxxxx"
}

Respuesta

La respuesta de la API será un objeto JSON con la siguiente estructura:

{
// objeto - Representa los resultados de la consulta divididos en páginas.
// En cada elemento de la lista, el campo ID actúa como un identificador único para cada fila de datos.
// Es importante notar que campos como URL, nombre, nombre del producto y precio son campos personalizados dinámicos.
// Sus definiciones y valores son determinados por el usuario y pueden ser modificados según requisitos específicos.
"Dati": {
"Elenco": [
{
"ID": 1,
"url": "XXXXX",
"nombre": "xiaomi",
"nombreprodotto": "xiaomi 16",
"prezzo": 999
},
{
"ID": 2,
"url": "XXXXX",
"nombre": "apple",
"nombreprodotto": "iphone 16 pro max",
"prezzo": 999
}
],
"ConteggioVirtuale": 2
},
// cadena - Versión de la API
"Version": "1.0.0",
// booleano - Estado de éxito de la operación
"Successo": true,
// entero - Código de estado HTTP
"Codice": 200,
// cadena - Mensaje de error, si está presente
"Messaggio": ""
}

Manejo de Errores

Si la solicitud falla, deberías:

1. Verificar el código de estado HTTP para errores en la red
2. Examinar los campos Code y Message en la respuesta para errores a nivel de negocio
3. El campo Message contendrá información detallada sobre el error