Zarejestruj się jako deweloper i uzyskaj klucz API

Zapewnia interfejsy RESTful API do tłumaczenia dokumentów, obsługując automatyczne zarządzanie zadaniami tłumaczeniowymi, spójność terminologii opartą na glosariuszach oraz zapytania dotyczące obsługiwanych formatów, języków i modeli, ułatwiając budowanie płynnych procesów tłumaczeniowych i zarządzanie kontami użytkowników.

Pierwsze kroki

Aby rozpocząć, musisz złożyć wniosek o zostanie deweloperem.Aplikuj jako programista

Po zatwierdzeniu można utworzyć wiele kluczy API i uwzględnić odpowiedni klucz API w każdym żądaniu API zgodnie z wymaganiami.

Uzyskaj swój klucz API

Szybkie podłączenie

Podstawowy URL

https://shangyiai.com/api

Metoda uwierzytelnienia

Authorization: [yourSecretKey]

Zapytanie JSON

Z wyjątkiem interfejsu przesyłania plików, interfejsy domyślnie używają żądań POST JSON, Content-Type to application/json.

Przesyłanie pliku

Tworzenie zadania tłumaczenia dokumentu wykorzystuje multipart/form-data, w polu file przekazywany jest plik do przetłumaczenia.

Uniwersalna odpowiedź błędu

W przypadku niepowodzenia żądania interfejs zwróci JSON, a pole error będzie zawierać stały komunikat o błędzie w języku angielskim. Zaleca się priorytetowe obsługiwanie błędów według kodu statusu HTTP, a pole error używać do wyświetlania lub zapisywania w logach.

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

Reguły kodów statusu błędów

Wszystkie odpowiedzi błędów API v1 mają taką samą strukturę, proszę obsługiwać według poniższych reguł kodu statusu HTTP.

400 Bad Request: Brak wymaganych parametrów, nieprawidłowe formaty parametrów lub wartości enum, brak przesłanego pliku, błąd zapisywania lub błąd przetwarzania zadania.
401 Unauthorized: Brak klucza API lub nieprawidłowy klucz API.
402 Payment Required: Niewystarczające saldo kredytowe na podgląd, pełne tłumaczenie lub tłumaczenie tekstu.
404 Not Found: Zadanie lub glosariusz nie istnieje, został usunięty, nie należy do bieżącego konta API lub nie został utworzony przez API.
409 Conflict: Bieżący status zadania nie pozwala na wykonanie żądanej operacji.
500 Internal Server Error: Nieoczekiwany wyjątek po stronie serwera. Błąd odpowiedzi jest ustawiony na stałe jako "Wewnętrzny błąd serwera.".

Zalecany proces integracji

1. Tworzenie zadania

Prześlij plik i utwórz zadanie tłumaczenia, zwraca taskId.

2. Sprawdzanie postępu

Odpytuj status zadania do momentu uzyskania statusu Completed, Terminated lub Cancelled.

3. Pobieranie wyniku

Pobierz plik tłumaczenia lub odczytaj JSON oryginału i tłumaczenia.

4. Zarządzanie zadaniami

Płać według użycia za pełne tłumaczenie, ponowne uruchomienie zadania, rewizję tekstu lub usunięcie zadania.

Zasoby

Społeczność deweloperów

W przypadku pytań możesz uzyskać pomoc w społeczności deweloperów.