Zu Content springen
Zur Tidely App
  • Es gibt keine Vorschläge, da das Suchfeld leer ist.

Die open API von Tidely 

Ab dem Professional-Tarif kannst Du mit der Tidely Public API eigene Integrationen bauen – um Rechnungen aus Deinem ERP-System automatisch zu importieren, Finanzpläne per Code zu pflegen oder Deine Daten in ein eigenes BI-Tool zu exportieren. 

Kapitel in diesem Artikel:

Was kannst Du mit der API machen?

Typische Anwendungsfälle:

  • ERP-Sync: Rechnungen automatisch aus Deiner Buchhaltungssoftware importieren
  • Finanzplanung automatisieren: Finanzpläne per Code erstellen und aktualisieren
  • Reporting: Finanzdaten in Dein eigenes BI-Tool oder Dashboard exportieren
  • Eigene Workflows: Aktionen in Tidely aus Deinen eigenen Systemen heraus auslösen

Die vollständige technische Referenz aller Endpunkte findest Du in der Public API Reference.

Voraussetzungen

  • Ein aktiver Tidely-Account im Professional-Tarif (oder höher)
  • API-Zugriff für Deinen Account (wende Dich an unseren Support, falls das bei Dir noch nicht aktiv ist)
  • Ein API-Key (siehe Abschnitt 3)

API-Key erstellen

  1. Logge Dich in Tidely ein.
  2. Gehe zu Einstellungen → Datenquellen → API-Schlüssel
  3. Klicke auf das +-Symbol.
  4. Vergib einen aussagekräftigen Namen (z. B. nach dem geplanten Einsatzzweck).
  5. Wähle die Firma, für die der Key gelten soll.
  6. Wähle die Berechtigungen aus, die der Key benötigt – beschränke ihn auf das, was Dein Anwendungsfall wirklich braucht.
  7. Speichere den Key sicher ab – er wird Dir nur einmal vollständig angezeigt.

Tipp: Nutze pro Integration einen eigenen Key. So kannst Du später einzelne Integrationen sperren, ohne andere zu beeinträchtigen.

Authentifizierung

Jede Anfrage an die API muss den API-Key im Header X-Authorization mitschicken.

Verbindung testen:

curl -X GET https://api.tidely.com/public/v2/authentication/verify-auth \
  -H "X-Authorization: DEIN_API_KEY"

Erfolgreiche Antwort:

{
  "success": true,
  "message": "Authentication successful",
  "name": "Name deines API-Keys"
}

Sicherheitsempfehlungen

  • Gib Deinen API-Key niemals in Client-seitigem Code, Versionsverwaltung (z. B. Git) oder Logs preis.
  • Rotiere Deine Keys regelmäßig – erstelle einen neuen und deaktiviere den alten.
  • Speichere den Key in Umgebungsvariablen, statt ihn fest im Code zu hinterlegen.
  • Ein Key pro Integration – so kannst Du gezielt einzelne Zugänge widerrufen.

API-Key widerrufen

Gehe zu Einstellungen → API-Keys, wähle beim betreffenden Key Löschen aus dem Menü. Der Key wird sofort ungültig.

Erste Schritte – Deine erste Anfrage

Bankkonten abrufen

curl -X GET https://api.tidely.com/public/v2/bank-accounts \
  -H "X-Authorization: DEIN_API_KEY"

Finanzplan anlegen

curl -X POST https://api.tidely.com/public/v2/plans \
  -H "X-Authorization: DEIN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "categoryName": "E-Commerce Revenue",
    "amount": 50000.00,
    "period": "MONTHLY",
    "date": "2025-01-01",
    "type": "ONE_TIME",
    "name": "January Revenue Target"
  }'

Rechnung importieren (z. B. aus Deinem ERP-System)

curl -X POST https://api.tidely.com/public/v2/invoices \
  -H "X-Authorization: DEIN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "invoiceId": "ERP-2025-001",
    "invoiceNumber": "2025-001",
    "contactName": "ACME Corp",
    "invoiceType": "SALES_INVOICE",
    "totalGrossAmount": 11900.00,
    "invoiceDate": "2025-01-15",
    "dueDate": "2025-02-15",
    "currency": "EUR"
  }'

Basis-URLs

Umgebung URL
Produktion https://api.tidely.com/public/v2
Staging https://api.sam.tidely.com/public/v2

Versionierung – was Du wissen musst

Die API nutzt semantische Versionierung, die Hauptversion steht im URL-Pfad (z. B. /public/v2). Innerhalb einer Hauptversion bleibt die API abwärtskompatibel.

Keine Versionsänderung nötig bei:

  • neuen optionalen Feldern in Anfragen
  • neuen Feldern in Antworten
  • neuen Endpunkten
  • neuen Werten in Aufzählungsfeldern (Enums) – behandle solche Felder in Deinem Code am besten als offene Strings, nicht als feste Liste

Versionsänderung (Breaking Change) bei:

  • entfernten oder umbenannten Feldern
  • geänderten Feldtypen
  • entfernten Endpunkten
  • geänderter Authentifizierung

Nutzt Du noch die ältere v1-API? Die Dokumentation dazu findest Du weiterhin unter api.tidely.com/tidely-open-api/swagger-ui. v1 wird zwar noch unterstützt, ist aber veraltet – ein Umstieg auf v2 lohnt sich.

Troubleshooting

Ich bekomme einen Authentifizierungsfehler. Prüfe, ob Du den Key korrekt im Header X-Authorization mitschickst (nicht Authorization) und ob der Key noch gültig ist (nicht gelöscht oder abgelaufen).

Ich habe keinen Zugriff auf die API. API-Zugriff muss für Deinen Account aktiviert sein und setzt den Professional-Tarif voraus. Wende Dich an unseren Support, wenn Du Zugriff benötigst.

Ein Endpunkt liefert nicht die erwarteten Felder. Prüfe, ob Du gegen die richtige Umgebung (Produktion vs. Staging) und die richtige Version (/public/v2) sprichst. Neue Felder werden ohne Versionssprung ergänzt – behandle unbekannte Felder in Deinem Code defensiv.

Mein API-Key funktioniert nicht mehr. Wurde der Key eventuell rotiert oder widerrufen? Erstelle in dem Fall einfach einen neuen unter Einstellungen → API-Keys.

Weiterführende Links

Noch Fragen? Melde Dich einfach bei unserem Support – wir helfen Dir gerne bei Deiner Integration weiter.