Registrera dig som utvecklare och få en API-nyckel

Tillhandahåller RESTful API:er för dokumentöversättning, med stöd för automatiserad hantering av översättningsuppgifter, ordlistebaserad terminologikonsistens och förfrågningar om stödda format, språk och modeller, vilket gör det enkelt att bygga sömlösa översättningsarbetsflöden och hantera användarkonton.

Komma igång

För att komma igång behöver du ansöka om att bli utvecklare.Ansök som utvecklare

När detta har godkänts kan du skapa flera API-nycklar och inkludera lämplig API-nyckel i varje API-förfrågan enligt behov.

Hämta din API-nyckel

Snabb integrering

Bas-URL

https://shangyiai.com/api

Autentiseringsmetod

Authorization: [yourSecretKey]

JSON-begäran

Förutom filuppladdningsgränssnittet använder API:et som standard POST JSON-förfrågningar, Content-Type är application/json.

Filuppladdning

Att skapa en dokumentöversättningsuppgift använder multipart/form-data, fältet file överför filen som ska översättas.

Allmänt felsvar

Vid misslyckad förfrågan returnerar gränssnittet JSON, där error-fältet innehåller ett fast engelskt felmeddelande. Det rekommenderas att prioritera att hantera fel enligt HTTP-statuskod, medan error-fältet används för visning eller loggning.

{
  "error": "Invalid API key."
}

Regler för felstatuskoder

Alla v1 API-felsvar behåller samma struktur, hantera enligt HTTP-statuskodreglerna nedan.

400 Bad Request: Nödvändiga parametrar saknas, ogiltiga parameterformat eller enum-värden, filuppladdning saknas, misslyckades att spara uppladdning, eller misslyckad bearbetning av uppgift.
401 Unauthorized: API-nyckel saknas eller är ogiltig.
402 Payment Required: Otillräckligt kreditsaldo för förhandsgranskning, fullständig översättning eller textöversättning.
404 Not Found: Uppgiften eller ordlistan existerar inte, har raderats, tillhör inte aktuellt API-konto, eller skapades inte via API:et.
409 Conflict: Den aktuella uppgiftsstatusen tillåter inte den begärda åtgärden.
500 Internal Server Error: Oväntat serverundantag. Svarsfelet är fastställt som "Internt serverfel.".

Rekommenderad integreringsprocess

1. Skapa uppgift

Ladda upp fil och skapa översättningsuppgift, returnerar taskId.

2. Fråga om förlopp

Poller uppgiftsstatus tills Completed, Terminated eller Cancelled.

3. Hämta resultat

Ladda ner översatt fil, eller läs källtext och översättnings-JSON.

4. Hantera uppgifter

Betala per användning för fulltext översättning, omstart av uppgifter, revidering av text eller radering av uppgifter.

Resurser

Utvecklarsamhälle

Om du har några frågor kan du få hjälp i utvecklargemenskapen.