Per iniziare

Una chiave

Creane una nella console per sviluppatori. Una chiave porta un insieme fisso di ambiti, e una chiamata la cui chiave non abbia l'ambito richiesto dal suo endpoint viene rifiutata invece che servita a metà. Chiedi l'insieme più stretto che faccia il lavoro: una chiave per l'analisi di mercato non ha motivo di leggere le richieste di nessuno.

Una prima chiamata

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

Oppure con un client:

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 });

Cosa torna indietro

Ogni esito positivo è incapsulato. Il contenuto sta sotto data, e tutto ciò che riguarda la risposta anziché la risorsa sta sotto meta. Una singola scheda e una collezione differiscono soltanto per il fatto che data sia un oggetto o un array, quindi un unico deserializzatore gestisce entrambe.

I fallimenti sono documenti di problema RFC 9457 che portano un code stabile. Ramifica sul codice e non sulla prosa di title o detail, che è scritta per una persona e può essere riformulata. Ogni fallimento porta inoltre un request_id: citalo quando chiedi di un caso specifico.

Il passo successivo

La paginazione è la prossima cosa che ti servirà, e la più facile da sbagliare in modo sottile.