Kom godt i gang
Brug PolyLingo HTTP API til at oversætte ren tekst, Markdown, JSON eller HTML, mens strukturen bevares intakt. Denne guide dækker produktions-endpointet, autentificering og din første succesfulde anmodning.
Basis-URL
Alle eksempler bruger produktions-API'et:
| URL | |
|---|---|
| Produktion | https://api.usepolylingo.com/v1 |
Hver sti nedenfor er relativ til denne base (for eksempel betyder POST /translate POST https://api.usepolylingo.com/v1/translate).
Hvis du kører din egen PolyLingo API-instans, skal du erstatte værten med din deployments-URL og beholde /v1-præfikset, medmindre du har konfigureret andet.
Autentificering
Beskyttede endpoints forventer din API-nøgle i Authorization-headeren:
Authorization: Bearer <your_api_key>
Få en nøgle: Opret en i PolyLingo-appen under API keys. Du ser kun den fulde nøgle én gang—gem den et sikkert sted (miljøvariabel eller hemmelighedshåndtering). Nøgler kan tilbagekaldes fra samme skærm.
Sikkerhed: Behandl nøglen som en adgangskode. Foretræk at kalde API'et fra din server, ikke fra offentlig browserkode, så nøglen aldrig udsættes for brugere.
Hvis headeren mangler, er forkert, eller nøglen er ugyldig eller tilbagekaldt, svarer API'et med 401 og error: "invalid_api_key".
Endpoints og nøgler
| Ingen nøgle krævet | GET /health — hurtig tilgængelighedskontrol |
GET /languages — understøttede sprogekoder | |
| Nøgle krævet | POST /translate — oversæt indhold |
POST /translate/batch — oversæt flere elementer | |
POST /jobs — sæt en langvarig oversættelse i kø (returnerer straks 202) | |
GET /jobs/:id — forespørg jobstatus; inkluderer queue_position mens du venter | |
GET /usage — brug for den autentificerede konto |
Første anmodning (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"
}'
Et succesfuldt svar inkluderer et translations-objekt (en post pr. målsprog, du har anmodet om) og et usage-objekt med tokenoptællinger.
Første anmodning (Node.js)
Node.js 18+ inkluderer 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)
Tjek at API'et er tilgængeligt
Ingen nøgle er nødvendig for sundhed:
curl -sS "https://api.usepolylingo.com/v1/health"
Du bør se en lille JSON-payload, der indikerer, at tjenesten er oppe. Brug GET /languages for listen over koder, du kan sende som targets.
CORS og browserapps
API'et kan begrænse, hvilke browser origins der kan kalde det direkte, så nøgler ikke bruges fra utroværdige sider. Server-side kald (Node, Python, edge-funktioner, din backend) er ikke begrænset af CORS.
For en single-page app er det sædvanlige mønster: din frontend taler til din backend, og din backend kalder PolyLingo med API-nøglen.
Næste skridt
- API reference — anmodnings- og svarformer, formater, fejl og grænser.