API & Technische Einrichtung

Diese Anleitung richtet sich an Entwickler oder technisch neugierige Benutzer, die verstehen möchten, wie die Kalenderintegration von apocha hinter den Kulissen funktioniert.

Für nicht-technische Benutzer ist alles, was du wissen musst, in unserer Schnellstart-Anleitung enthalten.

Die Kalender-URL

Die Grundlage unserer Kalenderintegration ist die Kalender-URL. Dies ist eine einzigartige URL, die für dein Konto generiert wird und einen Daten-Feed im Standard-iCalendar (.ics)-Format bereitstellt.

Jede Kalenderanwendung, die einen Internetkalender abonnieren kann (was praktisch alle modernen Kalender-Apps einschließt), kann diese URL verwenden, um deine Finanzereignisse anzuzeigen.

Sicherheit: API-Schlüssel

Um sicherzustellen, dass deine Finanzdaten privat bleiben, ist die Kalender-URL mit einem einzigartigen Token gesichert: deinem API-Schlüssel.

• Wie es funktioniert: Wenn du in der apocha-App einen API-Schlüssel erstellst, fungiert dieser als geheimes Passwort. Dieser Schlüssel ist in deiner Kalender-URL eingebettet. Wenn deine Kalender-App Daten von der URL anfordert, validiert der Server von apocha den API-Schlüssel, bevor er Informationen sendet.
• Einen Schlüssel erstellen: Du kannst deine API-Schlüssel erstellen und verwalten, indem du zu Einstellungen > Konto in der apocha-App navigierst.
• Zugriff widerrufen: Wenn du jemals glaubst, dass deine Kalender-URL kompromittiert wurde, kannst du einfach einen neuen API-Schlüssel in der apocha-App erstellen. Dadurch wird die alte URL sofort deaktiviert.

API-Endpunkt

Die Kalenderfunktion nutzt die öffentliche API von apocha. Während die derzeitige primäre Methode der Nutzung die Abonnementfunktion der Kalender-App ist, können die zugrunde liegenden Daten programmatisch abgerufen werden.

• API-Dokumentation: Detaillierte Informationen zu den verfügbaren Endpunkten, Parametern und Datenstrukturen findest du in unserer offiziellen Swagger UI API-Dokumentation.
• Authentifizierung: Alle API-Anfragen müssen mit deinem API-Schlüssel authentifiziert werden, der typischerweise als Bearer-Token im Request-Header oder als Query-Parameter übergeben wird.

Durch die Verwendung von branchenüblichen Formaten (.ics) und Sicherheitspraktiken (API-Schlüssel) bieten wir eine Kalenderintegration, die sowohl leistungsstark als auch sicher ist.