Erste Schritte

Ein Schlüssel

Legen Sie einen in der Entwicklerkonsole an. Ein Schlüssel trägt einen festen Satz von Berechtigungen, und ein Aufruf, dessen Schlüssel die vom Endpunkt verlangte Berechtigung nicht hat, wird abgelehnt und nicht teilweise bedient. Fragen Sie den engsten Satz an, der die Aufgabe erfüllt: Ein Schlüssel für Marktanalysen hat in niemandes Anfragen etwas zu suchen.

Ein erster Aufruf

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

Oder mit einem 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 });

Was zurückkommt

Jeder Erfolg ist in einen Umschlag gepackt. Die Nutzlast steht unter data, und alles, was die Antwort statt der Ressource betrifft, unter meta. Ein einzelner Datensatz und eine Sammlung unterscheiden sich nur darin, ob data ein Objekt oder ein Array ist, ein Deserialisierer bedient also beides.

Fehlschläge sind Problemdokumente nach RFC 9457 mit einem stabilen code. Verzweigen Sie über den Code und nicht über die Prosa in title oder detail, die für Menschen geschrieben ist und umformuliert werden kann. Jeder Fehlschlag trägt außerdem eine request_id: Nennen Sie sie, wenn Sie zu einem bestimmten Fall nachfragen.

Weiter

Paging ist das Nächste, was Sie brauchen werden, und das, was man am leichtesten unauffällig falsch macht.