Kuanzia

Tumia PolyLingo HTTP API kutafsiri maandishi ya kawaida, Markdown, JSON, au HTML huku ukihifadhi muundo. Mwongozo huu unahusu endpoint ya uzalishaji, uthibitishaji, na ombi lako la kwanza lenye mafanikio.

URL Msingi

Mifano yote inatumia API ya uzalishaji:

Kila njia hapa chini ni jamaa na hiyo msingi (kwa mfano, POST /translate inamaanisha POST https://api.usepolylingo.com/v1/translate).

Kama unafanya kazi na mfano wako binafsi wa API ya PolyLingo, badilisha mwenyeji na URL ya deployment yako na uhifadhi kiambishi /v1 isipokuwa umebainisha vinginevyo.

Uthibitishaji

Endpoints zilizo na ulinzi zinatarajia ufunguo wako wa API katika kichwa cha Authorization:

Authorization: Bearer <your_api_key>

Kupata ufunguo: Tengeneza mmoja katika app ya PolyLingo chini ya API keys. Unaona ufunguo kamili mara moja tu—uhifadhi mahali salama (kama variable ya mazingira au meneja wa siri). Funguo zinaweza kufutwa kutoka skrini hiyo hiyo.

Usalama: Tibu ufunguo kama nenosiri. Pendekeza kuita API kutoka kwa server yako, si kutoka kwa msimbo wa kivinjari wa umma, ili ufunguo usiwe wazi kwa watumiaji.

Kama kichwa hakipo, ni kibaya, au ufunguo ni batili au umefutwa, API itajibu kwa 401 na error: "invalid_api_key".

Endpoints na funguo

Ombi la kwanza (cURL)

export POLYLINGO_API_KEY="pl_your_key_here"

curl -sS -X POST "https://api.usepolylingo.com/v1/translate" \
  -H "Authorization: Bearer $POLYLINGO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "content": "# Hello\n\nThis is **bold**.",
    "format": "markdown",
    "targets": ["es", "fr"],
    "model": "standard"
  }'

Jibu lenye mafanikio linajumuisha kitu cha translations (kila lugha lengwa uliloomba) na kitu cha usage chenye hesabu za tokeni.

Ombi la kwanza (Node.js)

Node.js 18+ ina fetch:

const API_KEY = process.env.POLYLINGO_API_KEY
const res = await fetch('https://api.usepolylingo.com/v1/translate', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    Authorization: `Bearer ${API_KEY}`,
  },
  body: JSON.stringify({
    content: '# Hello\n\n**Bold** text.',
    format: 'markdown',
    targets: ['de', 'ja'],
    model: 'standard',
  }),
})
const data = await res.json()
if (!res.ok) throw new Error(`${data.error}: ${data.message}`)
console.log(data.translations)

Hakikisha API inapatikana

Hakuna ufunguo unaohitajika kwa health:

curl -sS "https://api.usepolylingo.com/v1/health"

Unapaswa kuona payload ndogo ya JSON inayoonyesha huduma iko hai. Tumia GET /languages kwa orodha ya misimbo unayoweza kupitisha kama targets.

CORS na apps za kivinjari

API inaweza kuzuia ni asili za kivinjari zipi zinaweza kuitisha moja kwa moja, ili funguo zisitumike kutoka tovuti zisizotegemewa. Mitoaji wa server-side (Node, Python, edge functions, backend yako) haziwekwi vizingiti vya CORS.

Kwa app ya ukurasa mmoja, mtindo wa kawaida ni: frontend yako huwasiliana na backend yako, na backend yako huwaita PolyLingo na ufunguo wa API.

Hatua zinazofuata

• Marejeleo ya API — maumbo ya maombi na majibu, miundo, makosa, na mipaka.