...
| Section |
|---|
|
| Column |
|---|
Table of Contents| Table of Contents |
|---|
| exclude | (Table of Contents|Read on|Custom Client Built Build with Libraries|Web-API Gateway \(API-WEB\)|yuuvis® architect) |
|---|
|
|
|
...
The endpoints for the management of localization files provided by the Web-API Gateway (API-WEB) are available only for users with specific administrative roles. Furthermore, the endpoints require the specification of the language for which the localization file should be retrieved/updated. The language has to be specified in ISO norm (e.g., de, en, es, fr, ...) in the request header for GET endpoints and in the request URL for the POST endpoints:
| User Role | Available Endpoints for Localization Management | Description | ISO Language Specification | Kind of Localization File |
|---|
| YUUVIS_TENANT_ADMIN | GET /api-web/api/admin/resources/text | | Insert excerpt |
|---|
| GET /api-web/api/admin/resources/text |
|---|
| GET /api-web/api/admin/resources/text |
|---|
| nopanel | true |
|---|
|
| in the request header Accept-Language | Tenant-specific: available only within the tenant the currently logged-in user belongs to. |
| POST /api-web/api/admin/resources/text/{locale} | | Insert excerpt |
|---|
| POST /api-web/api/admin/resources/text/{locale} |
|---|
| POST /api-web/api/admin/resources/text/{locale} |
|---|
| nopanel | true |
|---|
|
| as path parameter |
| YUUVIS_SYSTEM_INTEGRATOR | GET /api-web/api/system/resources/text | | Insert excerpt |
|---|
| GET /api-web/api/system/resources/text |
|---|
| GET /api-web/api/system/resources/text |
|---|
| nopanel | true |
|---|
|
| in the request header Accept-Language | Global: available for all tenants. |
| POST /api-web/api/system/resources/text/{locale} | | Insert excerpt |
|---|
| POST /api-web/api/system/resources/text/{locale} |
|---|
| POST /api-web/api/system/resources/text/{locale} |
|---|
| nopanel | true |
|---|
|
| as path parameter |
The endpoints can be called via Swagger-UI.
>> Web-API Gateway Endpoints
...