Aller au contenu

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.

RéférenceDéveloppeur
Voir en Markdown

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

ChampTypeContraintes
idUUID—
codechaîne10 caractères au plus, format xx ou xx-XX (fr, pt-BR) ; unique sur la plateforme
namechaîne50 caractères au plus, sans HTML
isDefaultbooléenlangue par défaut du référentiel

Depuis la console, le code saisi doit faire deux lettres minuscules.

Rattachement d'une langue à l'application

ChampTypeDescription
appIdUUIDapplication
languageIdUUIDlangue
isDefaultbooléenlangue par défaut de l'application ; une seule par application

Langues obligatoires : fr et en.

Types de fichiers

TypeNom du fichier
FRONTi18-<WID>-front-<langue>.json
BACKi18-<WID>-back-<langue>.json
EXTRAi18-<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émentValeur
Clé de traduction255 caractères
Valeur de traduction5 000 caractères, HTML actif refusé
Pagination du référentiel des langues20 par page par défaut, 500 au plus

Endpoints de l'API publique

URL de base : https://api.wakastart.app/api.

Méthode et cheminAccèsUsage
GET /languagesdroit languages.readréférentiel des langues, paginé (page, limit)
GET /languages/code/{code}droit languages.readune langue par son code
GET /languages/code/{code}/file?appWid=&fileType=droit languages.readadresse du fichier de traduction : { s3Url, s3Key }
POST /languages/find-or-createAdministrateur client et droit languages.manageretrouver ou créer une langue : { code, name }
GET /app-languages/app/{appId}authentifiélangues de l'application (appId : UUID ou WID)
POST /app-languagesAdministrateur clientrattacher une langue : { appId, languageId, isDefault? }
PUT /app-languages/app/{appId}/language/{languageId}/defaultAdministrateur clientdésigner la langue par défaut
DELETE /app-languages/app/{appId}/language/{languageId}Administrateur clientretirer une langue ; 204
GET /apps/{appWid}/runtime-configauthentifié, jeton de l'applicationlangues de l'application avec isDefault

Revendication du jeton enrichi

RevendicationContenu
wlngcode de la langue retenue : préférence de l'utilisateur, sinon client, sinon réseau ; absente sinon