Pengenalan

Menyediakan RESTful APIs untuk terjemahan dokumen, menyokong pengurusan tugas terjemahan automatik, konsistensi terminologi berasaskan glosari, dan pertanyaan untuk format, bahasa, dan model yang disokong, memudahkan pembinaan aliran kerja terjemahan yang lancar dan pengurusan akaun pengguna.

Bermula

Untuk bermula, anda perlu memohon untuk menjadi pembangun.Mohon sebagai pembangun

Setelah diluluskan, anda boleh mencipta berbilang kunci API dan memasukkan kunci API yang sesuai dalam setiap permintaan API mengikut keperluan.

Dapatkan kunci API anda

Akses Pantas

Base URL

https://otranslator.com/api

Kaedah Pengesahan

Authorization: [yourSecretKey]

Permintaan JSON

Kecuali antara muka muat naik fail, antara muka secara lalai menggunakan permintaan POST JSON, Content-Type ialah application/json.

Muat Naik Fail

Membuat tugas terjemahan dokumen menggunakan multipart/form-data, medan file menghantar fail yang perlu diterjemahkan.

Respons Ralat Umum

Apabila permintaan gagal, antara muka akan mengembalikan JSON, medan error mengandungi maklumat ralat tetap dalam bahasa Inggeris. Disyorkan untuk mengutamakan pengendalian ralat berdasarkan kod status HTTP, medan error digunakan untuk paparan atau rakaman log.

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

Peraturan Kod Status Ralat

Semua respons kesilapan API v1 mengekalkan struktur yang sama, sila kendalikan mengikut peraturan kod status HTTP yang berikut.

400 Bad Request: Missing required parameters, invalid parameter formats or enum values, missing file upload, upload save failure, or task processing failure.
401 Unauthorized: Missing API key or invalid API key.
402 Payment Required: Insufficient credits balance for preview, full translation, or text translation.
404 Not Found: The task or glossary does not exist, has been deleted, does not belong to the current API account, or was not created through the API.
409 Conflict: The current task status does not allow the requested operation.
500 Internal Server Error: Unexpected server exception. The response error is fixed as "Internal server error.".

Proses akses yang disyorkan

1. Cipta tugasan

Muat naik fail dan cipta tugasan terjemahan, pulangkan taskId.

2. Semak kemajuan

Semak status tugasan secara berkala, sehingga Completed, Terminated atau Cancelled.

3. Dapatkan keputusan

Muat turun fail terjemahan, atau baca JSON teks sumber dan terjemahan.

4. Urus tugasan

Bayar mengikut penggunaan untuk terjemahan teks penuh, mula semula tugasan, semakan semula teks atau padam tugasan.

Sumber

Komuniti pembangun

Jika anda mempunyai sebarang soalan, anda boleh mendapatkan bantuan dalam komuniti pembangun.