Paano gumagana ang mga API key?

Ang mga API key ay ang iyong mga kredensyal sa pagpapatunay (authentication) para ma-access ang Cathopic API. Ang pag-unawa kung paano ito gumagana ay mahalaga para sa ligtas at epektibong pagsasama (API integration).

Ano ang API key?

Ang API key ay isang natatanging lihim na token na tumutukoy sa iyong application at nagbibigay ng pahintulot para ma-access ang Cathopic API:

• Isang mahabang alphanumeric na string (hal., sk_live_abc123xyz789...)

• Gumaganap bilang parehong authentication at authorization

• Nakaugnay sa iyong Cathopic account at billing

• Maaaring aktibo o hindi aktibo

Siklo ng buhay ng key

Paglikha:

1. Bumuo ng mga key sa Settings → API

2. Bigyan ang bawat key ng mapaglarawang pangalan ("Production Website", "Staging", "Mobile App")

3. Kopyahin agad ang buong key—ipapakita lang ito nang isang beses

4. Iimbak nang ligtas (environment variables, secrets manager, password manager)

Paggamit:

• Isama sa x-api-key HTTP header sa bawat request

• Ang mga key ay beripikado sa server-side sa bawat request

• Ang lahat ng paggamit ng API ay sinusubaybayan at sinisingil sa iyong account

Pagde-deactivate:

• Maaaring pansamantalang i-disable ang mga key nang hindi tinatanggal

• Kapaki-pakinabang para sa troubleshooting o pag-pause ng partikular na integration

• Maaari itong muling i-activate anumang oras

Pagtanggal:

• Permanenteng inaalis ang key

• Hindi na mababawi o maibabalik

• Lahat ng request gamit ang key na iyon ay agad mabibigo

Mga alituntunin sa pamamahala ng key

Seguridad:

• Huwag kailanman i-commit ang mga key sa version control: Gamitin .env mga file at idagdag sa .gitignore

• Huwag kailanman ilantad sa client-side code: Dapat gamitin ang mga API key sa server-side lamang

• Gumamit ng environment variables: Iimbak ang mga key sa process.env.CATHOPIC_API_KEY o katumbas

• Mag-rotate nang regular: Palitan ang mga key paminsan-minsan (tuwing quarterly o pagkatapos magbago ang miyembro ng team)

• Gumamit ng magkakahiwalay na key bawat environment: Iba-iba ang key para sa dev, staging, at production

Organisasyon:

• Mapaglarawang pangalan: Pangalanan ang mga key ayon sa layunin: "Production Website", "iOS App", "Email System"

• I-dokumento ang pagmamay-ari: Tukuyin kung aling miyembro ng team ang gumawa ng bawat key

• Regular na audit: Suriin ang mga aktibong key buwan-buwan at alisin ang mga hindi ginagamit

Maramihang API key

Maaari kang gumawa ng maraming API key para sa iba’t ibang layunin:

• Bawat environment: Magkahiwalay na key para sa development, staging, at production

• Bawat application: Iba-iba ang key para sa website, mobile app, at internal tools

• Bawat miyembro ng team: Mga indibidwal na key para sa mga developer (mas madaling subaybayan at i-revoke)

Ang lahat ng key sa ilalim ng iyong account ay may iisang billing. Ang paggamit mula sa lahat ng key ay pinagsasama sa iyong buwanang invoice.

Pagsubaybay sa paggamit ng key

Subaybayan ang aktibidad para sa bawat key:

1. Pumunta sa Settings → API

2. Tingnan ang listahan ng lahat ng key kasama ang huling petsa na ginamit

3. I-click ang isang key para makita ang detalyadong istatistika ng paggamit

4. Mag-monitor para sa hindi inaasahang aktibidad

Ano ang gagawin kung may nakompromisong key

Kung naniniwala kang nalantad ang isang API key:

1. Agad na tanggalin o i-deactivate ang key sa Settings → API

2. Bumuo ng bagong kapalit na key

3. I-update ang iyong application gamit ang bagong key

4. Suriin ang mga log ng paggamit para sa anumang kahina-hinalang aktibidad

5. Makipag-ugnayan sa support kung may makita kang hindi awtorisadong paggamit

Halimbawa: Ligtas na pag-iimbak ng mga key

Node.js gamit ang environment variables:

// .env file (add to .gitignore!)
CATHOPIC_API_KEY=sk_live_abc123xyz789...
// Your code
require('dotenv').config();
const apiKey = process.env.CATHOPIC_API_KEY;
fetch('https://api.cathopic.com/resources', {
  method: 'POST',
  headers: {
    'x-api-key': apiKey,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({ query: 'Jesus' })
});

Python gamit ang environment variables:

import os
import requests
api_key = os.environ.get('CATHOPIC_API_KEY')
response = requests.post(
    'https://api.cathopic.com/resources',
    headers={'x-api-key': api_key},
    json={'query': 'Jesus'}
)