SDKs und Werkzeuge

OpenAPI

Die vollständige Spezifikation liegt unter /openapi.json (OpenAPI 3.1). Daraus erzeugst du Clients in jeder Sprache, zum Beispiel mit openapi-generator oder orval.

Die API-Referenz ist aus derselben Datei erzeugt und immer aktuell.

TypeScript

npm install @freika/sdk

import { Freika } from "@freika/sdk";

const freika = new Freika({ apiKey: process.env.FREIKA_API_KEY! });

const payment = await freika.payments.create(
  { amount: 2450, currency: "CHF", channel: "terminal", terminalId: "trm_theke_links" },
  { idempotencyKey: "bon-42" },
);

for await (const event of freika.terminals.events("trm_theke_links")) {
  if (event.type === "payment.succeeded") break;
}

Das SDK erscheint mit Phase 6 der Plattform. Bis dahin nutzt du die REST-API direkt, die Beispiele in dieser Dokumentation funktionieren ohne SDK.

PHP

composer require freika/freika-php

Geplant für Phase 6. Wenn du früher eine PHP-Anbindung brauchst, schreib an developer@freika.com.

Postman

Importiere /openapi.json in Postman oder Insomnia. Setze die Variable apiKey und den Server auf https://api.freika.com.

Kassensysteme

Du baust ein Kassensystem? Die Kassenintegration beschreibt Terminalzahlungen mit Long-Polling und WebSocket. Im Partnerprogramm unterstützen wir dich bei der Integration.