Ano ang Cathopic API?

Huling na-update: 3 buwan ang nakalipas

Ang aming API ay isang RESTful na serbisyo na nagbibigay-daan sa iyong isama nang direkta ang Catholic media library ng Cathopic sa iyong mga application. Ma-access ang libu-libong larawan, video, at graphics nang programmatically.

Ano ang magagawa mo

  • Maghanap at mag-browse sa pamamagitan ng aming kumpletong katalogo

  • Maglisensya ng mga resources para sa iyong mga end-user nang awtomatiko

  • Mag-download sa maraming format na na-optimize para sa iba’t ibang paggamit

  • Mag-access ng mayamang metadata kabilang ang mga tag, paglalarawan, at liturgical na impormasyon

Arkitekturang REST

Binuo sa mga karaniwang prinsipyo ng REST:

  • Base URL: https://api.cathopic.com

  • Format ng data: Mga kahilingang JSON at mga tugon

  • Pagpapatunay: API key sa pamamagitan ng x-api-key header

  • HTTP method: POST para sa lahat ng endpoints

Apat na pangunahing endpoints

  • POST /resources - Maghanap sa katalogo

  • POST /resource - Kumuha ng mga detalye tungkol sa isang partikular na item

  • POST /confirm - Maglisensya ng isang resource at kumuha ng mga download URL

  • POST /remove - Itigil ang paglilisensya kapag hindi na kailangan (website lang)

Kumpletong dokumentasyon

Ang lahat ng kailangan mo ay available online:

  • Interactive na API reference: api.cathopic.com/docs

  • Mga halimbawa ng code sa maraming wika

  • Masusing detalye ng mga parameter

Pagsisimula

  1. Makipag-ugnayan sa aming team para humiling ng access sa API

  2. Bumuo ng iyong API key sa Settings → API

  3. Magdagdag ng paraan ng pagbabayad para sa pagsingil sa paggamit

  4. Simulan ang pagbuo

Tingnan ang iba pang mga tanong sa seksyong ito para sa mga detalye tungkol sa pagpapatunay, pagsingil, at pinakamahuhusay na kasanayan.

Kasunduan sa Lisensya ng API

Ang lahat ng paggamit ng API ay napapailalim sa aming Kasunduan sa Lisensya ng API. Mga pangunahing punto na dapat maunawaan:

  • Digital use lamang: Ang nilalaman ay maaari lamang ipakita sa mga web at email na kapaligiran

  • Walang pagda-download ng file: Ang mga end user ay hindi maaaring mag-download o mag-export ng mga orihinal na file

  • Mga ipinagbabawal na paggamit: Mahigpit na ipinagbabawal ang AI/ML training, mga naka-print na materyales, at offline na paggamit

  • Pagsingil batay sa paggamit: Magbabayad lamang para sa aktwal na paggamit ng nilalaman ng iyong mga end user

  • Sa pamamagitan ng paggamit ng API, tinatanggap mo ang lahat ng mga tuntunin sa kasunduan sa lisensya

Bago isama ang API:

  1. Suriin ang kumpletong Kasunduan sa Lisensya ng API

  2. Unawain ang mga paghihigpit at obligasyon

  3. Tiyaking ang iyong sitwasyon ng paggamit ay sumusunod sa mga kinakailangan na digital-only

  4. Planuhin ang iyong pagsasama upang tumpak na masubaybayan ang paggamit para sa pagsingil

Para sa higit pang detalye, tingnan:

Nakatulong ba ang artikulong ito?