Référence des langues et traductions
Objets langue et langue d'application, types de fichiers, format publié, endpoints de l'API publique et limites.
ReferenceDeveloper
This page has not been translated yet and is shown in French.
Valeurs de référence des langues et des fichiers de traduction. Le détail de chaque endpoint figure dans la référence API des contenus de l'application.
Objet langue
| Champ | Type | Contraintes |
|---|---|---|
id | UUID | — |
code | chaîne | 10 caractères au plus, format xx ou xx-XX (fr, pt-BR) ; unique sur la plateforme |
name | chaîne | 50 caractères au plus, sans HTML |
isDefault | booléen | langue par défaut du référentiel |
Depuis la console, le code saisi doit faire deux lettres minuscules.
Rattachement d'une langue à l'application
| Champ | Type | Description |
|---|---|---|
appId | UUID | application |
languageId | UUID | langue |
isDefault | booléen | langue par défaut de l'application ; une seule par application |
Langues obligatoires : fr et en.
Types de fichiers
| Type | Nom du fichier |
|---|---|
FRONT | i18-<WID>-front-<langue>.json |
BACK | i18-<WID>-back-<langue>.json |
EXTRA | i18-<WID>-extra-<langue>.json |
Chemin de stockage : langs/<WID>/<langue>/<nom du fichier>. Contenu : objet JSON imbriqué selon les points des clés ; une clé sans valeur vaut "". Cache : max-age=3600.
Limites
| Élément | Valeur |
|---|---|
| Clé de traduction | 255 caractères |
| Valeur de traduction | 5 000 caractères, HTML actif refusé |
| Pagination du référentiel des langues | 20 par page par défaut, 500 au plus |
Endpoints de l'API publique
URL de base : https://api.wakastart.app/api.
| Méthode et chemin | Accès | Usage |
|---|---|---|
GET /languages | droit languages.read | référentiel des langues, paginé (page, limit) |
GET /languages/code/{code} | droit languages.read | une langue par son code |
GET /languages/code/{code}/file?appWid=&fileType= | droit languages.read | adresse du fichier de traduction : { s3Url, s3Key } |
POST /languages/find-or-create | Administrateur client et droit languages.manage | retrouver ou créer une langue : { code, name } |
GET /app-languages/app/{appId} | authentifié | langues de l'application (appId : UUID ou WID) |
POST /app-languages | Administrateur client | rattacher une langue : { appId, languageId, isDefault? } |
PUT /app-languages/app/{appId}/language/{languageId}/default | Administrateur client | désigner la langue par défaut |
DELETE /app-languages/app/{appId}/language/{languageId} | Administrateur client | retirer une langue ; 204 |
GET /apps/{appWid}/runtime-config | authentifié, jeton de l'application | langues de l'application avec isDefault |
Revendication du jeton enrichi
| Revendication | Contenu |
|---|---|
wlng | code de la langue retenue : préférence de l'utilisateur, sinon client, sinon réseau ; absente sinon |