Primeros pasos

Una clave

Créala en la consola para desarrolladores. Una clave lleva un conjunto fijo de permisos, y una llamada cuya clave no tenga el permiso que exige su endpoint se rechaza en lugar de servirse a medias. Pide el conjunto más estrecho que haga el trabajo: una clave para análisis de mercado no tiene por qué leer las consultas de nadie.

Una primera llamada

curl -sS https://api.skautik.com/v1/api/properties?city=Berlin \
  -H "Authorization: Bearer $SKAUTIK_API_KEY"

O con un cliente:

import { Skautik } from "@skautik/sdk";

const skautik = new Skautik({ apiKey: process.env.SKAUTIK_API_KEY! });

const page = await skautik.properties.list({ city: "Berlin", maxPrice: 750000 });

Qué responde

Todo éxito viene envuelto. El contenido va bajo data, y todo lo relativo a la respuesta y no al recurso va bajo meta. Una ficha suelta y una colección solo se diferencian en si data es un objeto o un array, así que un único deserializador vale para ambas.

Los fallos son documentos de problema RFC 9457 que llevan un code estable. Ramifica según el código y no según la prosa de title o detail, que está escrita para una persona y puede reescribirse. Todo fallo lleva además un request_id: cítalo cuando preguntes por uno concreto.

Lo siguiente

Paginación es lo siguiente que vas a necesitar, y lo más fácil de equivocar sutilmente.