/
API-Schnittstelle zu Drittanbietersoftware

API-Schnittstelle zu Drittanbietersoftware

API Beschreibung

Diese API ermöglicht den Zugriff auf die Gewinnspar-Anwendung, um bestimmte Daten abzurufen und Daten an die Anwendung zu übermitteln. Sie dient als zentrale Schnittstelle, über die externe Systeme oder Anwendungen Daten mit der Gewinnspar-Plattform austauschen können.

Anwendungsfälle:

Automatisiertes Reporting

Daten-Management

Echtzeit Integration

Automatisiertes Reporting

Daten-Management

Echtzeit Integration

Externe Anwendungen können Informationen für Berichte oder Analysen abfragen.

Externe Systeme können Daten in der Gewinnspar-Anwendung erzeugen oder aktualisieren.

Die API ermöglicht die Integration der Gewinnspar-Anwendung in bestehende Systeme.

Kernfunktionen:

• Datenabruf

Externe Anwendungen können Informationen aus der Gewinnspar-Anwendung anfordern.

• Datenübermittlung

Externe Anwendungen können direkt in der Gewinnspar-Anwendung Daten aktualisieren oder neue Daten erstellen.

Authentifizierung:

• Authentifizierung

erfolgt über JWT Token + Bearer Auth HTTPHeader.

• API User

werden vom Systemadministrator im Benutzeradministrationsbereich der Bank verwaltet.

Technische Details:

Diese API folgt den Prinzipien der RESTful-Architektur und nutzt Standard-HTTP-Methoden (GET, POST) für verschiedene Vorgänge. Der gesamte Datenaustausch erfolgt im JSON-Format, das eine schlanke und weit verbreitete kompatible Struktur bietet. Die API verwendet standardisierte Fehlerbehandlung mit entsprechenden HTTP-Statuscodes und detaillierten Fehlermeldungen im JSON-Format, was eine effektive Fehlerbehebung und eine robuste Anwendungsentwicklung ermöglicht. Die Sicherheit wird durch eine obligatorische HTTPS-Verschlüsselung für die gesamte Kommunikation gewährleistet, wodurch sensible Daten während der Übertragung geschützt werden. Für das Sicherheitsmanagement können API-Benutzer bei Bedarf über die Verwaltungsschnittstelle deaktiviert oder erneuert werden.

Endpoints:

  1. Branches

    1. List Branches

  2. Categories

    1. List Categories

  3. Donations

    1. List Donations

    2. Create Donations

    3. List Donation Related Documents

    4. Create Donation Related Documents

    5. Read Donation by id

    6. Update Donation

    7. Validate Donation for Generating PDF

    8. Validate Donation for Request Approval

  4. Enums

    1. List Federal States

    2. List Donation Pdf Types

    3. List Beneficiary Purposes for Pdf Type

    4. List Transfer Types for Pdf Type

    5. List Donation Statuses

    6. List Gsv Types

  5. Expiring Links

    1. Donation Pdf Download Expiring link generation

    2. Donation Signed Document Upload Expiring link generation

  6. Global Settings

    1. Read Active Gsv Type

  7. Institutions

    1. List Institution Related Documents

    2. Create Institution Related Documents

    3. List Institutions

  8. Profile

    1. Read my account

  9. Users

    1. List Users (already Existing)

    2. Read User by id (already existing)

Webhooks:

  1. Donation Status Update

  2. Donation Update

 Dokumentation:

Eine detaillierte Dokumentation der Endpunkte und Webhooks mit Wert- und Code-Beispielen ist für den API User innerhalb der Gewinnspar-Anwendung einsehbar.

Beispiel Workflows: