Premiers pas

Une clé

Créez-en une dans la console développeur. Une clé porte un ensemble fixe de portées, et un appel dont la clé n'a pas la portée exigée par son endpoint est refusé plutôt que servi à moitié. Demandez l'ensemble le plus étroit qui fasse le travail : une clé destinée à l'analyse de marché n'a rien à faire dans les demandes de qui que ce soit.

Un premier appel

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

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

Ce qui revient

Chaque succès est enveloppé. La charge utile se trouve sous data, et tout ce qui concerne la réponse plutôt que la ressource se trouve sous meta. Une fiche unique et une collection ne diffèrent que par le fait que data soit un objet ou un tableau : un seul désérialiseur traite donc les deux.

Les échecs sont des documents de problème RFC 9457 portant un code stable. Branchez sur le code plutôt que sur la prose de title ou detail, écrite pour une personne et susceptible d'être reformulée. Chaque échec porte aussi un request_id : citez-le quand vous posez une question sur un cas précis.

La suite

La pagination est la prochaine chose dont vous aurez besoin, et la plus facile à rater subtilement.