Czym jest API Cathopic?

Ostatnia aktualizacja: 3 miesiące temu

Nasze API to usługa REST, która pozwala zintegrować bibliotekę katolickich mediów Cathopic bezpośrednio z Twoimi aplikacjami. Uzyskaj programowo dostęp do tysięcy obrazów, wideo i grafik.

Co możesz zrobić

  • Wyszukiwać i przeglądać w ramach pełnego katalogu

  • Automatycznie licencjonować zasoby dla Twoich użytkowników końcowych

  • Pobierać w wielu formatach zoptymalizowanych pod różne zastosowania

  • Uzyskiwać dostęp do bogatych metadanych, w tym tagów, opisów i informacji liturgicznych

Architektura REST

Zbudowane w oparciu o standardowe zasady REST:

  • Adres bazowy: https://api.cathopic.com

  • Format danych: żądania i odpowiedzi w formacie JSON

  • Uwierzytelnianie: klucz API w nagłówku x-api-key

  • Metoda HTTP: POST dla wszystkich endpointów

Cztery kluczowe endpointy

  • POST /resources - Wyszukiwanie w katalogu

  • POST /resource - Pobieranie szczegółów dotyczących konkretnego elementu

  • POST /confirm - Licencjonowanie zasobu i uzyskanie adresów URL do pobrania

  • POST /remove - Zatrzymanie licencjonowania, gdy nie jest już potrzebne (tylko strona internetowa)

Kompletna dokumentacja

Wszystko, czego potrzebujesz, jest dostępne online:

  • Interaktywna referencja API: api.cathopic.com/docs

  • Przykłady kodu w wielu językach

  • Szczegółowe specyfikacje parametrów

Jak zacząć

  1. Skontaktuj się z naszym zespołem, aby poprosić o dostęp do API

  2. Wygeneruj swój klucz API w Ustawienia → API

  3. Dodaj metodę płatności do rozliczeń za użycie

  4. Rozpocznij budowanie

Sprawdź pozostałe pytania w tej sekcji, aby uzyskać szczegóły dotyczące uwierzytelniania, rozliczeń i najlepszych praktyk.

Umowa licencyjna API

Wszelkie korzystanie z API podlega naszej Umowie licencyjnej API. Kluczowe punkty, które należy zrozumieć:

  • Wyłącznie użycie cyfrowe: treści mogą być wyświetlane jedynie w środowiskach internetowych i e-mail

  • Brak pobierania plików: użytkownicy końcowi nie mogą pobierać ani eksportować oryginalnych plików

  • Zabronione zastosowania: szkolenie AI/ML, materiały drukowane oraz użycie offline są surowo zabronione

  • Rozliczenia oparte na użyciu: płacisz tylko za faktyczne wykorzystanie treści przez Twoich użytkowników końcowych

  • Korzystając z API, akceptujesz wszystkie warunki umowy licencyjnej

Przed integracją API:

  1. Przeczytaj całą Umowę licencyjną API

  2. Zrozum ograniczenia i obowiązki

  3. Upewnij się, że Twoje zastosowanie jest zgodne z wymaganiami dotyczącymi użycia wyłącznie cyfrowego

  4. Zaplanuj integrację tak, aby dokładnie śledzić użycie na potrzeby rozliczeń

Aby uzyskać więcej informacji, zobacz:

Czy ten artykuł był pomocny?