API Développeur

Vous pouvez maintenant gérer votre compte en utilisant les API REST de Wordly. Vous pouvez consulter la documentation OpenAPI et essayer les API vous-même sur la page Référence de l'API à condition d'avoir une clé API développeur.
Veuillez noter que la page de Référence de l'API agit sur des données en direct, soyez donc prudent lorsque vous l'utilisez.
De nouvelles fonctionnalités seront ajoutées régulièrement, restez à l'écoute pour plus de mises à jour !

Historique des modifications

Cliquez ici pour consulter l'historique des modifications.

Obtenir une clé API Développeur

Une clé API développeur doit être incluse comme valeur dans l'en-tête pour toutes les requêtes.

Prérequis

Un compte Wordly avec des minutes disponibles.
Votre compte Wordly doit être ajouté à une liste d'autorisation par le support Wordly.

Une fois que votre compte a été ajouté à la liste d'autorisation, vous pouvez créer une clé API non expirante dans le portail :

Allez sur votre page de profil utilisateur dans le portail Wordly.
Cliquez sur le bouton + dans la ligne Clé API pour créer une nouvelle clé API.

Si vous ne voyez pas la ligne Clé API dans votre profil, cela signifie que votre compte n'a pas été ajouté à la liste d'autorisation.

Ne partagez pas cette clé sans comprendre les risques de sécurité. Cette clé doit rester secrète ; sinon, un acteur malveillant pourrait vous usurper l'identité et accéder à votre compte via les API. Si vous soupçonnez que votre compte a été compromis, supprimez immédiatement votre clé API.

Supprimer une clé API Développeur

Si vous souhaitez supprimer et révoquer votre clé API, vous pouvez le faire via le portail.

Pour supprimer et révoquer votre clé API

Après avoir supprimé votre clé API dans le Portail, il y aura un petit délai avant que la clé ne soit complètement révoquée. Ce n'est pas immédiat.

Allez sur votre page de profil utilisateur dans le portail Wordly.
Cliquez sur le bouton de la poubelle dans la ligne Clé API pour supprimer votre clé API.

Vous êtes libre de générer une nouvelle clé API après avoir supprimé celle qui existe.

En-tête d'Autorisation

Afin d'utiliser l'API, vous devez inclure l'en-tête x-wordly-api-key avec chaque requête. La valeur de cet en-tête est votre clé API développeur.

Exemple : x-wordly-api-key: f716690b-4e9a-4656-9523-7003637eb6cc

L'absence de fourniture de la clé API dans l'en-tête entraînera une réponse 401 (Non autorisé) du serveur.

Gestion des Versions

À mesure que de nouvelles versions de l'API sont publiées, les schémas de corps de requête et de réponse peuvent changer.

Wordly inclut l'en-tête x-wordly-api-versiondans chaque réponse, qui vous indique à quelle version de l'API le corps de la réponse est conforme.

Exemple : x-wordly-api-version: 1.0

Vous pouvez également fournir l'en-tête x-wordly-api-versiondans vos requêtes pour fixer le schéma de corps de requête et de réponse à une version d'API spécifique. Cela garantit que vos requêtes continueront de fonctionner lorsque de nouvelles versions de l'API seront publiées.

Si vous ne fournissez pas l'en-tête x-wordly-api-versiondans vos requêtes, Wordly assumera la dernière version de l'API. C'est pourquoi nous vous recommandons fortement d'inclure cet en-tête avec chaque requête.

Si vous avez une version dans l'en-tête qui a été dépréciée, vous recevrez une erreur 403 Interdit. Un préavis est donné au cas où une version d'API serait dépréciée et marquée pour une suppression future. Vous trouverez l'avis dans l'historique des modifications de l'API.

Ceci suppose que la version de l'API en question est toujours prise en charge. Un préavis sera donné dans le cas où une version d'API serait dépréciée et marquée pour une suppression future.

Erreurs

Si une erreur se produit lors du traitement de votre requête, vous recevrez une réponse d'erreur HTTP. Dans la plupart des cas, vous recevrez un corps de réponse JSON dans le format suivant :
{ "message": "An error message will be here.", "code": 2003, "errors": [ { "message": "Any additional error information..." }, { "message": "...will be listed here." } ] }

Le champ code est un code d'erreur numérique spécifique à Wordly. Le tableau ci-dessous est une liste des codes d'erreur possibles que vous pourriez recevoir dans une réponse d'erreur.

Code d'Erreur	Description
2003	Non autorisé à effectuer cette action.
2026	Un champ n'est pas valide.
2041	L'opération ne peut pas être complétée car la session est en cours d'utilisation.
5001	Des champs obligatoires sont manquants dans la requête.
5002	Un champ n'est pas valide.
5004	La ressource demandée n'a pas pu être trouvée.

Corps de la Requête Webhook de Sous-titrage

L'API de Sous-titrage permet à une session Wordly en cours d'envoyer des sous-titres en direct à une URL de webhook désignée. Les sous-titres continueront d'être générés et envoyés jusqu'à ce que la session Wordly se termine ou jusqu'à ce que le sous-titrage soit explicitement arrêté à l'aide de l'API.

Une URL de webhook doit être fournie lors de la requête pour démarrer le sous-titrage d'une session Wordly. Lorsque Wordly génère des segments de sous-titres, ils seront envoyés à l'URL du webhook via une requête POST.

Le corps de cette requête POST sera un seul objet JSON qui contient les champs suivants.

Champ JSON	Type	Description
`sequence`	nombre	Le numéro de séquence pour ce segment de sous-titre qui définit l'ordre dans lequel les sous-titres doivent être affichés, en commençant par 1. Cela sera toujours défini à la bonne valeur par le service, et les segments de sous-titres seront envoyés à l'URL du webhook dans cet ordre. Généralement, les segments de sous-titres arriveront également dans l'ordre ; cependant, sachez que ce n'est pas une garantie en raison des conditions de réseau échappant au contrôle de Wordly. Par conséquent, le numéro de séquence peut être utilisé pour vérifier l'ordre des segments de sous-titres à mesure qu'ils arrivent.
`language`	chaîne	Un code de langue Wordly. Le texte du sous-titre sera dans cette langue.
`text`	chaîne	Le texte réel du sous-titre formaté comme spécifié par les paramètres de sous-titrage qui ont été fournis lorsque le sous-titrage a été demandé.
`duration`	nombre	Combien de temps le sous-titre doit être affiché en millisecondes.

ID de Packs de Voix

Des ID de packs de voix peuvent être attribués aux sessions, ce qui est un mappage organisé, un-à-un, de voix aux langues disponibles pour les participants Wordly. Les participants utilisant l'application Web Attend de Wordly entendront les transcriptions et les traductions en utilisant les voix du pack spécifié s'ils choisissent d'utiliser la fonction de synthèse vocale.

Actuellement, il n'existe aucun moyen de récupérer par programme une liste des packs de voix disponibles. Cependant, les packs de voix organisés suivants peuvent être utilisés lors de la spécification de l'ID du pack de voix pour une session.

Nom du Pack de Voix	ID du Pack de Voix
Voix Féminine	672def43-f760-451c-82f8-c01711ccaa84
Voix Masculine	97cc30b9-a883-47d5-a2d1-0ad89fc69187

Si vous ne spécifiez pas de pack de voix lors de la
création d'une session à l'aide de l'API, la session créée utilise le pack de voix sélectionné dans votre profil Wordly. Par défaut, votre profil sera configuré pour utiliser le pack de voix par défaut, qui est actuellement la Voix Féminine.

Vous pouvez écouter des échantillons des packs de voix pour différentes langues lors de la modification d'une session ou de la mise à jour de votre profil dans le portail Wordly.