Paano ako makakapag-download ng mga larawan sa pamamagitan ng API?

Mahalagang paglilinaw: Ang API ay hindi nagpapahintulot ng "pagda-download" sa tradisyonal na kahulugan. Sa halip, nagbibigay ito ng permanenteng mga URL sa nilalamang na-optimize para sa web na hinahain ng iyong application sa mga end user. Ito ay pinamamahalaan ng aming Kasunduan sa Lisensya ng API.

HINDI mo dina-download ang mga file

Ang Cathopic API ay gumagana sa panimula na naiiba sa mga tradisyonal na pagda-download:

• Walang paglilipat ng file: Hindi mo kailanman natatanggap o naiimbak ang aktuwal na mga file ng larawan/video

• Pag-access na nakabatay sa URL: Ang API ay nagbibigay ng mga URL na tumuturo sa nilalamang naka-host sa Cathopic

• Web-optimized lamang: Ang nilalaman ay hinahain sa resolusyong angkop para sa digital na pagpapakita

• Walang orihinal na mga file: Ang mga orihinal na may mataas na resolusyon ay HINDI kailanman naa-access sa pamamagitan ng API

• Laging naka-host: Ang nilalaman ay nananatili sa mga server ng Cathopic o sa awtorisadong CDN

Magagamit na mga resolusyon

: Ang API ay nagbibigay ng tatlong laki na na-optimize para sa web:

• Maliit: Angkop para sa mga thumbnail at maliliit na embed (karaniwang ~400px ang lapad)

• Katamtaman: Maganda para sa karaniwang nilalaman sa web (karaniwang ~800px ang lapad)

• Malaki: Pinakamahusay ang kalidad para sa pagpapakita sa web (karaniwang ~1200px ang lapad)

Mahahalagang paghihigpit:

• Ang mga orihinal na high-resolution na file ay HINDI kailanman ibinibigay

• Ang mga resolusyon ay na-optimize para sa pagpapakita sa screen, hindi para sa pagpi-print

• Ang mga laki ng file ay pinipiga para sa mabilis na paghahatid sa web

• Hindi ka makakahiling ng mga custom na resolusyon o orihinal na kalidad

Para sa kumpletong mga tuntunin, basahin ang buong Kasunduan sa Lisensya ng API at suriin ang teknikal na dokumentasyon sa api.cathopic.com/docs.

Ang pagda-download ng mga larawan ay may dalawang hakbang: pagli-lisensya sa resource gamit ang /confirm, pagkatapos ay gamitin ang mga URL na ibinalik.

Hakbang 1: I-lisensya ang resource

Tawagin /confirm para i-lisensyahan ang isang resource para sa partikular na end-user:

POST https://api.cathopic.com/confirm
x-api-key: YOUR_API_KEY
{
  "media_id": 1234,
  "usage_type": "website",
  "client_identifier": "user_123"
}

Mga parameter:

• media_id - Ang resource ID mula sa iyong mga resulta ng paghahanap

• usage_type - Alinman sa "website" o "email"

• client_identifier - Natatanging ID para sa iyong end-user

Hakbang 2: Gamitin ang mga download URL

Ang tugon ay naglalaman ng mga permanenteng URL sa maraming format:

{
  "download_url": {
    "avif": {
      "320": "https://...",
      "640": "https://...",
      "1280": "https://...",
      "1920": "https://...",
      "2560": "https://..."
    },
    "jpeg": {
      "320": "https://...",
      "640": "https://...",
      "1280": "https://...",
      "1920": "https://...",
      "2560": "https://..."
    }
  }
}

Mahalaga: I-store ang mga URL

Ang mga URL na ibinabalik ay permanente - i-store ang mga ito sa iyong database:

// Pagkatapos tumawag sa /confirm
const response = await api.confirm(mediaId, userId);
// I-store sa iyong database
await db.save({
  userId: userId,
  mediaId: mediaId,
  avifUrls: response.download_url.avif,
  jpegUrls: response.download_url.jpeg,
  licensedAt: new Date()
});
// Sa susunod, kunin mula sa DB imbes na tumawag muli sa /confirm

Pagpili ng tamang format

Format na AVIF:

• Mas maliliit na laki ng file (mas magandang performance)

• Mas mahusay na compression

• Inirerekomenda para sa mga modernong browser

• Hindi sinusuportahan sa mga lumang browser

Format na JPEG:

• Pangkalahatang compatibility

• Mas malalaking laki ng file

• Gamitin bilang fallback para sa mga lumang browser

Mahahalagang paalala

⚠️ Laging suriin ang iyong database bago tumawag sa /confirm. Ang pagtawag nito nang maraming beses para sa parehong user at resource ay lilikha ng mga duplicate na singil.

Buong dokumentasyon sa api.cathopic.com/docs.