Zum Inhalt springen

Open Beta – hilf uns beim Testen! Alle Inserate sind nur Beispiele.

Quickstart

Erstelle einen API-Key und mach in unter fünf Minuten deinen ersten authentifizierten WOHNO-API-Call.

Dieser Quickstart bringt dich in unter fünf Minuten von null zu einem erfolgreichen API-Call. Du erstellst einen API-Key in deinem Dashboard und liest damit deine Inserate über https://wohno.de/api/v1.

Bevor du startest

Du brauchst ein WOHNO-Konto und eine Organisation. Falls du noch keine hast, erstelle zuerst ein Konto — jeder API-Key gehört zu einer Organisation, und jeder Call läuft im Kontext dieser Organisation.

Schritt 1 — API-Key erstellen

  1. Öffne Dashboard → Einstellungen → API unter https://wohno.de/dashboard/settings.
  2. Klicke auf API-Key erstellen.
  3. Wähle den Key-Typ:
    • Secret Key (sk_…) — für die Server-zu-Server-Nutzung. Er kann jeden Scope tragen (read, write, delete). Nimm diesen für den Quickstart.
    • Publishable Key (pk_…) — für die Browser-/Embed-Nutzung. Nur lesend und mit zwingend erforderlicher Origin-Allowlist. Im Authentifizierungs-Guide erfährst du, welcher zu deinem Use Case passt.
  4. Vergib den Scope listings:read (reicht für diesen Quickstart).
  5. Kopiere den Secret-Wert jetzt — ein Secret Key wird genau einmal angezeigt und nur als Hash gespeichert. Wenn du ihn verlierst, erstelle einen neuen Key.

Dein Key sieht so aus: sk_live_xxxxxxxxxxxxxxxxxxxxxxxx. Behandle ihn wie ein Passwort: niemals in Git committen und niemals in ein Browser-Bundle ausliefern.

Schritt 2 — Deinen ersten Call machen

Schicke einen GET-Request an /api/v1/listings mit deinem Key im X-API-Key-Header:

curl https://wohno.de/api/v1/listings \
  -H "X-API-Key: sk_live_xxxxxxxxxxxxxxxxxxxxxxxx"

Du solltest einen HTTP 200 mit einem JSON-Body erhalten. Eine erfolgreiche Antwort sieht so aus (gekürzt):

{
  "data": [
    {
      "id": "9f1c2a3b-...",
      "title": "Bright 2-room apartment",
      "status": "published"
    }
  ],
  "pagination": {
    "next_cursor": "eyJpZCI6...",
    "has_more": true,
    "limit": 20
  }
}

Das war's — du hast deinen ersten authentifizierten WOHNO-API-Call gemacht.

Schritt 3 — Die Antwort verstehen

  • Envelope — Listen-Endpoints verpacken Ergebnisse in data. GET /api/v1/listings nutzt Cursor-Pagination: Reiche pagination.next_cursor als nächstes ?cursor= weiter, solange pagination.has_more true ist. (Manche Endpoints wie GET /api/v1/organizations nutzen stattdessen Offset-Pagination mit einem meta-Objekt — siehe die Konventions-Referenz.)
  • Rate-Limit-Header — jede Antwort trägt X-RateLimit-Limit, X-RateLimit-Remaining und X-RateLimit-Reset. Das Limit liegt bei 1000 Requests pro Stunde pro Key.
  • Quota-HeaderX-Quota-Limit, X-Quota-Used, X-Quota-Reset und X-Quota-Status melden den monatlichen Verbrauch deiner Organisation (standardmäßig nur Tracking).
  • Fehler — im Fehlerfall lautet der Body { "error": { "code", "message", "status" } }. Verzweige immer über den stabilen code, nicht über den message-Text.

Probier einen anderen Endpoint

Deine Organisationen aufzulisten funktioniert genauso (hier Offset-Pagination):

curl "https://wohno.de/api/v1/organizations?page=1&per_page=20" \
  -H "X-API-Key: sk_live_xxxxxxxxxxxxxxxxxxxxxxxx"

Nächste Schritte

  • Authentifizierungs-Guide — Key-Typen, Scopes, Origin-Allowlists, Rotation und Auth-Fehler.
  • API-Referenz — die vollständige, interaktive Endpoint-Referenz.
  • Use-Case-Guides — End-to-End-Anleitungen für typische Integrationen.