เริ่มต้น

ใช้ PolyLingo HTTP API เพื่อแปล ข้อความธรรมดา, Markdown, JSON หรือ HTML โดยยังคงโครงสร้างไว้ครบถ้วน คู่มือนี้ครอบคลุมถึง endpoint สำหรับการใช้งานจริง, การตรวจสอบสิทธิ์ และคำขอแรกที่สำเร็จของคุณ

URL ฐาน

ตัวอย่างทั้งหมดใช้ API สำหรับการใช้งานจริง:

เส้นทางทั้งหมดด้านล่างนี้สัมพันธ์กับฐานนี้ (เช่น POST /translate หมายถึง POST https://api.usepolylingo.com/v1/translate)

หากคุณใช้งานอินสแตนซ์ PolyLingo API ของคุณเอง ให้แทนที่โฮสต์ด้วย URL การปรับใช้ของคุณและเก็บคำนำหน้า /v1 ไว้ เว้นแต่คุณจะตั้งค่าไว้ต่างออกไป

การตรวจสอบสิทธิ์

Endpoints ที่ได้รับการป้องกันจะคาดหวังคีย์ API ของคุณในส่วนหัว Authorization:

Authorization: Bearer <your_api_key>

การรับคีย์: สร้างคีย์ได้ในแอป PolyLingo ภายใต้ API keys คุณจะเห็นคีย์เต็มเพียงครั้งเดียว—เก็บไว้ในที่ปลอดภัย (ตัวแปรสภาพแวดล้อมหรือผู้จัดการความลับ) คีย์สามารถเพิกถอนจากหน้าจอเดียวกันนี้

ความปลอดภัย: ปฏิบัติต่อคีย์เหมือนรหัสผ่าน ควรเรียก API จาก เซิร์ฟเวอร์ ของคุณ ไม่ใช่จากโค้ดเบราว์เซอร์สาธารณะ เพื่อไม่ให้คีย์ถูกเปิดเผยต่อผู้ใช้

หากส่วนหัวขาดไป ผิดพลาด หรือคีย์ไม่ถูกต้องหรือถูกเพิกถอน API จะตอบกลับด้วย 401 และ error: "invalid_api_key"

Endpoints และคีย์

คำขอแรก (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"
  }'

การตอบกลับที่สำเร็จจะรวมวัตถุ translations (หนึ่งรายการต่อภาษาที่คุณร้องขอ) และวัตถุ usage ที่มีการนับโทเค็น

คำขอแรก (Node.js)

Node.js 18+ มี 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)

ตรวจสอบว่า API เข้าถึงได้

ไม่ต้องใช้คีย์สำหรับ health:

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

คุณควรเห็น payload JSON เล็ก ๆ ที่บ่งชี้ว่าบริการกำลังทำงาน ใช้ GET /languages สำหรับรายการรหัสที่คุณสามารถส่งเป็น targets

CORS และแอปเบราว์เซอร์

API อาจจำกัดว่า ต้นทางเบราว์เซอร์ ใดสามารถเรียกโดยตรงได้ เพื่อไม่ให้คีย์ถูกใช้จากไซต์ที่ไม่น่าเชื่อถือ การเรียกจาก ฝั่งเซิร์ฟเวอร์ (Node, Python, edge functions, backend ของคุณ) จะไม่ถูกจำกัดโดย CORS

สำหรับ แอปหน้าเดียว รูปแบบปกติคือ: frontend ของคุณสื่อสารกับ backend ของคุณ และ backend ของคุณเรียก PolyLingo ด้วยคีย์ API

ขั้นตอนถัดไป

• เอกสารอ้างอิง API — รูปแบบคำขอและการตอบกลับ, รูปแบบ, ข้อผิดพลาด และข้อจำกัด