Waafir
Diese Seite ist eine maschinelle Übersetzung, die noch auf eine menschliche Prüfung wartet. Sie kann Fehler enthalten.

Cookbook

Dieses Cookbook richtet sich an Fintech-Entwickler, die ihr Kreditportfolio an die Überwachungs-API von Waafir anbinden. Jedes Rezept führt eine Aufgabe vollständig mit allen drei Referenz-Clients durch – cURL, TypeScript, Python –, sodass Leser nicht im Kopf zwischen Sprachen übersetzen müssen. Die Rezepte konzentrieren sich auf die Fehler- und Grenzfälle, auf die eine echte Integration stößt, nicht nur auf den Idealfall.

Für wen dieses Cookbook gedacht ist

Sie haben von der Administration Ihrer Waafir-Organisation ein persönliches Zugriffstoken (PAT) erhalten und schreiben den Code, der Ihre täglichen Loan-Tape-Daten – Kreditnehmer, Kredite, geplante Rückzahlungen, tatsächliche Zahlungen, Sicherheiten und Bewertungen der Sicherheiten – an Waafir übermittelt. Jede Übermittlung wird so erfasst, wie sie gesendet wurde, und anschließend als Zeilen gespeichert; von dort speist sie die Überwachungsregisterkarte für Investoren in jedem Datenraum, der mit dem Portfolio verknüpft ist.

So verwenden Sie diese Rezepte

Jedes Rezept hat denselben Aufbau: eine kurze Einleitung in Prosa, drei Codeblöcke in fester Reihenfolge und einen kurzen Absatz zur Überprüfung. Die Codeblöcke sind:

  1. cURL – zum Kopieren und Einfügen in Ihre Shell. Am wenigsten festgelegt; nützlich für einmalige Tests und CI-Prüfungen.
  2. TypeScript – auf Basis von fetch gegen die öffentlichen JSON-Verträge. Keine SDK-Installation erforderlich.
  3. Python – auf Basis von requests gegen dieselben JSON-Verträge. Die Standardbibliothek genügt; es ist kein Waafir-spezifisches Paket erforderlich.

Authentifizierung

Alle Endpunkte erfordern ein PAT im Authorization-Header:

Authorization: Bearer <YOUR_PAT>

Ein PAT gilt für genau eine Waafir-Organisation und trägt bei jeder Anfrage die Identität dieser Organisation. Behandeln Sie es als Geheimnis; rotieren Sie es über das Dashboard, falls es offengelegt wird. Die API-Basis-URL in diesen Rezepten ist durchgehend https://app.waafir.io – ersetzen Sie sie durch Ihre Staging-URL, wenn Sie zunächst gegen den Sandbox-Mandanten integrieren.

In den Rezepten verwendete Konventionen

  • Alle Shell-Variablen in den cURL-Beispielen werden als ${UPPER_CASE_NAME} geschrieben, sodass Sie sie einmal mit export setzen und in allen Rezepten wiederverwenden können.
  • Die TypeScript- und Python-Beispiele gehen davon aus, dass BASE_URL und PAT aus der Umgebung gelesen werden. Passen Sie dies an Ihren Konfigurationslader an.
  • Der Header Idempotency-Key ist die plattformweite Konvention für sichere Wiederholungen; die genaue Semantik finden Sie im Rezept zu Wiederholungen.
  • Alle schreibenden Endpunkte akzeptieren Ihre eigenen external_id-Werte – vom Aufrufer gelieferte Kennungen bleiben über Erfassung, Abgleich und Tape-Downloads hinweg der maßgebliche Bezug. Sie müssen die internen UUIDs von Waafir nie kennen.

Was das Cookbook nicht abdeckt

Das Cookbook ist aufgabenorientiert. Vollständige Endpunktdefinitionen, Anfrage- und Antwortschemas sowie Referenzen zu Fehlercodes finden Sie im Abschnitt zur API-Referenz, sobald dieser zusammen mit dem Cookbook erscheint. Zu Produktkonzepten, etwa was ein Portfolio ist und wie es mit einem Datenraum zusammenhängt, siehe Datenräume und den Abschnitt zu den Grundkonzepten.

Die Rezepte

  1. Ein Loan Tape per asynchronem NDJSON-Import im Ganzen importieren – der grundlegende Erfassungsablauf: direkter Upload, Commit, Abfragen bis zum Abschluss.
  2. Einen Import vor dem Übernehmen der Daten per Probelauf validieren – derselbe Ablauf mit ?dryRun=true; erfahren Sie, was Ihre Datei enthält, bevor Zeilen geschrieben werden.
  3. Sicher mit einem Idempotenzschlüssel wiederholen – vorübergehende Netzwerkfehler überstehen, ohne doppelte Importe zu erzeugen.
  4. Teilfehler nach einem Import untersuchen – zeilenbezogene Fehler seitenweise durchgehen, wenn ein Import als partial endet.
  5. Einen laufenden Import abbrechen – einen lang laufenden Import an der nächsten Batch-Grenze stoppen, ohne teilweise geschriebene Zeilen.
  6. Ihre Daten anhand der externen ID abgleichen – anhand Ihrer eigenen Kennung bestätigen, dass eine Zeile angekommen ist, und die täglichen Zählungen prüfen.