Was ist die Cathopic-API?

Zuletzt aktualisiert: vor 3 Monaten

Unsere API ist ein RESTful-Dienst, mit dem Sie die katholische Medienbibliothek von Cathopic direkt in Ihre Anwendungen integrieren können. Greifen Sie programmgesteuert auf Tausende von Bildern, Videos und Grafiken zu.

Was Sie tun können

  • Suchen und durchstöbern Sie unseren vollständigen Katalog

  • Ressourcen lizenzieren Sie automatisch für Ihre Endnutzer

  • Herunterladen in mehreren Formaten, optimiert für unterschiedliche Anwendungsfälle

  • Auf umfangreiche Metadaten zugreifen, einschließlich Tags, Beschreibungen und liturgischer Informationen

REST-Architektur

Aufgebaut nach gängigen REST-Prinzipien:

  • Basis-URL: https://api.cathopic.com

  • Datenformat: JSON-Anfragen und -Antworten

  • Authentifizierung: API-Schlüssel über den x-api-key-Header

  • HTTP-Methode: POST für alle Endpunkte

Vier zentrale Endpunkte

  • POST /resources - Sucht im Katalog

  • POST /resource - Ruft Details zu einem bestimmten Element ab

  • POST /confirm - Lizenziert eine Ressource und gibt Download-URLs zurück

  • POST /remove - Beendet die Lizenzierung, wenn sie nicht mehr benötigt wird (nur Website)

Umfangreiche Dokumentation

Alles, was Sie brauchen, ist online verfügbar:

  • Interaktiver API-Referenzleitfaden: api.cathopic.com/docs

  • Code-Beispiele in mehreren Sprachen

  • Detaillierte Angaben zu Parametern

Erste Schritte

  1. Kontaktieren Sie unser Team, um API-Zugriff anzufordern

  2. Erstellen Sie Ihren API-Schlüssel in Einstellungen → API

  3. Fügen Sie eine Zahlungsmethode für die nutzungsbasierte Abrechnung hinzu

  4. Beginnen Sie mit dem Aufbau

Sehen Sie sich die anderen Fragen in diesem Abschnitt an, um Details zu Authentifizierung, Abrechnung und bewährten Vorgehensweisen zu erhalten.

API-Lizenzvereinbarung

Alle Nutzungen der API unterliegen unserer API-Lizenzvereinbarung. Wichtige Punkte, die Sie verstehen sollten:

  • Nur digitale Nutzung: Der Inhalt darf nur in Web- und E-Mail-Umgebungen angezeigt werden

  • Keine Dateidownloads: Endnutzer können die Originaldateien nicht herunterladen oder exportieren

  • Untersagte Verwendungen: KI/ML-Training, Druckmaterialien und Offline-Nutzung sind streng verboten

  • Abrechnung nach Nutzung: Zahlen Sie nur für die tatsächliche Inhaltsnutzung durch Ihre Endnutzer

  • Mit der Nutzung der API akzeptieren Sie alle Bedingungen der Lizenzvereinbarung

Bevor Sie die API integrieren:

  1. Prüfen Sie die vollständige API-Lizenzvereinbarung

  2. Verstehen Sie die Einschränkungen und Pflichten

  3. Stellen Sie sicher, dass Ihr Anwendungsfall den Anforderungen „nur digital“ entspricht

  4. Planen Sie Ihre Integration so, dass die Nutzung für die Abrechnung genau erfasst wird

Weitere Details finden Sie unter:

War dieser Artikel hilfreich?