Registrer dig som udvikler og få en API-nøgle
Leverer RESTful API'er til dokumentoversættelse, der understøtter automatiseret håndtering af oversættelsesopgaver, ordlistebaseret terminologisk konsistens og forespørgsler om understøttede formater, sprog og modeller, hvilket gør det nemt at bygge sømløse oversættelsesworkflows og administrere brugerkonti.
Kom i gang
For at komme i gang skal du ansøge om at blive udvikler.Ansøg som udvikler
Når det er godkendt, kan du oprette flere API-nøgler og inkludere den relevante API-nøgle i hver API-anmodning efter behov.
Hurtig integration
Base URL
https://shangyiai.com/api
Autentificeringsmetode
Authorization: [yourSecretKey]
JSON anmodning
Bortset fra filupload-interfacet bruger interfacerne som standard POST JSON-anmodninger, hvor Content-Type er application/json.
Filopload
Oprettelse af dokumentoversættelsesopgave bruger multipart/form-data, file-feltet overfører den fil, der skal oversættes.
Generel fejlsvar
Når anmodningen mislykkes, returnerer interfacet JSON, error-feltet indeholder en fast engelsk fejlmeddelelse. Det anbefales først at håndtere fejl baseret på HTTP-statuskode, error-feltet bruges til visning eller logregistrering.
{
"error": "Invalid API key."
}Regler for fejlstatuskoder
Alle v1 API fejlsvar opretholder samme struktur, behandl venligst efter nedenstående HTTP status code regler.
- 400 Bad Request
- Manglende påkrævede parametre, ugyldige parameterformater eller enum-værdier, manglende filupload, fejl ved lagring af upload eller fejl i opgavebehandling.
- 401 Unauthorized
- Manglende API-nøgle eller ugyldig API-nøgle.
- 402 Payment Required
- Utilstrækkelig kreditbalance til forhåndsvisning, fuld oversættelse eller tekstoversættelse.
- 404 Not Found
- Opgaven eller ordlisten eksisterer ikke, er blevet slettet, tilhører ikke den nuværende API-konto, eller blev ikke oprettet gennem API'en.
- 409 Conflict
- Den aktuelle opgavestatus tillader ikke den anmodede operation.
- 500 Internal Server Error
- Uventet serverundtagelse. Responsfejlen er fastsat som "Intern serverfejl.".
Anbefalet integrationsproces
1. Opret opgave
Upload fil og opret oversættelsesopgave, returnerer taskId.
2. Forespørg fremskridt
Forespørg opgavestatus indtil Completed, Terminated eller Cancelled.
3. Hent resultat
Download oversat fil, eller læs original og oversættelse som JSON.
4. Administrer opgaver
Betal efter brug for fuld tekstoversættelse, genstart opgaver, revidér tekst eller slet opgaver.