S'inscrire en tant que développeur et obtenir une clé API

Fournit des API RESTful pour la traduction de documents, prenant en charge la gestion automatisée des tâches de traduction, la cohérence terminologique basée sur des glossaires et les requêtes pour les formats, langues et modèles pris en charge, facilitant ainsi la création de flux de travail de traduction fluides et la gestion des comptes utilisateurs.

Premiers pas

Pour commencer, vous devez déposer une candidature pour devenir développeur.Postuler en tant que développeur

Une fois approuvé, vous pouvez créer plusieurs clés API et inclure la clé API appropriée dans chaque requête API selon les besoins.

Obtenez votre clé API

Accès rapide

URL de base

https://shangyiai.com/api

Méthode d'authentification

Authorization: [yourSecretKey]

Requête JSON

À l'exception de l'interface de téléchargement de fichiers, les interfaces utilisent par défaut des requêtes POST JSON, le Content-Type est application/json.

Téléversement de fichier

La création d'une tâche de traduction de document utilise multipart/form-data, le champ file reçoit le fichier à traduire.

Réponse d'erreur générique

Lorsque la requête échoue, l'interface retourne un JSON, le champ error contient un message d'erreur fixe en anglais. Il est recommandé de traiter d'abord les erreurs selon le code de statut HTTP, le champ error est utilisé pour l'affichage ou l'enregistrement dans les journaux.

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

Règles de codes d'état d'erreur

Toutes les réponses d'erreur de l'API v1 maintiennent la même structure, veuillez traiter selon les règles de code de statut HTTP suivantes.

400 Bad Request: Paramètres requis manquants, formats de paramètres ou valeurs d'énumération invalides, téléchargement de fichier manquant, échec de l'enregistrement du téléchargement, ou échec du traitement de la tâche.
401 Unauthorized: Clé API manquante ou clé API invalide.
402 Payment Required: Crédit insuffisant pour l'aperçu, la traduction complète ou la traduction de texte.
404 Not Found: La tâche ou le glossaire n'existe pas, a été supprimé, n'appartient pas au compte API actuel, ou n'a pas été créé via l'API.
409 Conflict: Le statut actuel de la tâche ne permet pas l'opération demandée.
500 Internal Server Error: Exception serveur inattendue. L'erreur de réponse est définie comme "Erreur serveur interne.".

Processus d'intégration recommandé

1. Créer une tâche

Téléverser un fichier et créer une tâche de traduction, renvoie taskId.

2. Consulter la progression

Interroger l'état de la tâche jusqu'à Completed, Terminated ou Cancelled.

3. Obtenir les résultats

Télécharger le fichier traduit ou lire les JSON source et cible.

4. Gérer les tâches

Paiement à l'usage pour la traduction complète du texte, redémarrer la tâche, réviser le texte ou supprimer la tâche.

Ressources

Communauté de développeurs

Si vous avez des questions, vous pouvez obtenir de l'aide auprès de la communauté des développeurs.