Listings APIListings API
Iniciar sesión

Primeros pasos

Crea tu cuenta, añade un método de pago, obtén tu clave de API y realiza tu primera llamada a Listings API.

Esta guía explica cómo crear una cuenta, obtener tu primera clave de API y realizar una solicitud a Listings API.

1. Crea tu cuenta

Elige un plan en la página de precios para abrir el formulario de registro y, a continuación, introduce tu first name (nombre), last name (apellidos), work email (correo electrónico de trabajo) y company (empresa). ¿Ya tienes una cuenta? Inicia sesión en su lugar.

2. Añade un método de pago

Después de enviar el formulario, te redirigimos a nuestro proveedor de pagos para que añadas una tarjeta. Tu prueba gratuita comienza de inmediato y se convierte en el plan que elegiste cuando termina, así que cancela antes de ese momento si no quieres que se te cobre. Las preguntas frecuentes sobre precios indican la duración actual de la prueba y los límites de los planes.

3. Establece tu contraseña e inicia sesión

Una vez completado el proceso de pago, te enviamos por correo electrónico un enlace para establecer tu contraseña y activar tu cuenta. Después de establecer tu contraseña, inicia sesión con tu correo electrónico y contraseña, o elige Email me a sign-in link (enviarme un enlace de inicio de sesión por correo electrónico) para recibir un enlace mágico de un solo uso como alternativa.

4. Obtén tu clave de API

Tu primera clave de API se emite automáticamente al crear tu cuenta; la encontrarás en el panel, en API Keys. Para crear otra, elige New key (nueva clave), asígnale un nombre y selecciona su nivel de acceso (Read (lectura) o Write (escritura)).

5. Realiza tu primera solicitud

Autentica cada solicitud con un encabezado Authorization cuyo valor sea la cadena literal API (ten en cuenta el espacio final), seguida de tu clave:

Shell
curl https://listingsapi.com/api/v4/locations \  -H "Authorization: API $LISTINGSAPI_KEY"

La respuesta tiene una estructura anidada en lugar de ser un array sin estructura adicional: los resultados están en data.allLocations, cada registro es un edges[].node y pageInfo contiene el cursor de paginación y los totales.

JSON
{  "data": {    "allLocations": {      "edges": [        {          "cursor": "TG9jYXRpb246MTgwMDI4OQ==",          "node": {            "id": "TG9jYXRpb246MTgwMDI4OQ==",            "databaseId": 1800289,            "name": "Jenny Home",            "city": "Austin",            "stateIso": "TX",            "countryIso": "US"          }        }      ],      "pageInfo": {        "endCursor": "TG9jYXRpb246MTgwMDI4OQ==",        "hasNextPage": false,        "total": 1      }    }  }}

Para avanzar de página, vuelve a enviar pageInfo.endCursor como ?after=… mientras pageInfo.hasNextPage sea true, y detente también si una página devuelve un array edges vacío. Cada edge también contiene su propio cursor, y el cursor del último edge es el endCursor de esa página, por lo que cualquiera de los dos valores sirve como ?after=.

No todos los endpoints de listado paginan de la misma manera

La estructura edges / node / pageInfo anterior corresponde al estilo de cursor Relay y es solo una de las tres:

  • Páginas con cursor (first, after → edges[].node más pageInfo con endCursor / hasNextPage): ubicaciones, búsqueda de ubicaciones y endpoints de reseñas (interacciones por ubicación y resumen agregado de la cuenta).
  • Páginas con desplazamiento (page, perPage → un array records más pageInfo con totalRecords, totalPages, hasNextPage, hasPreviousPage): cuentas conectadas, sugerencias de conexión, publicaciones de una ubicación, publicaciones en bloque de una ubicación y resumen agregado de fichas duplicadas de toda la cuenta.
  • Arrays simples, sin ningún tipo de paginación: los endpoints del catálogo (subcategorías, países y estados, sitios del plan) y las fotos de una ubicación.

Consulta el ejemplo de respuesta en la página del propio endpoint antes de escribir un bucle de paginación; un bucle con cursor que consulta un endpoint con desplazamiento lee una clave edges que nunca está presente.

Próximos pasos