Índice del documento

API de Glosario

Actualizar glosario de términos

POST/v1/glossary/update

Actualiza los detalles del glosario o los términos.

Dirección completa
https://shangyiai.com/api/v1/glossary/update
Autenticación
Debe incluirse la API Key en el encabezado de solicitud Authorization
Content-Type
application/json
Formato incorrecto
{ "error": "Invalid API key." }

Precauciones

Los campos no proporcionados mantendrán su valor original sin cambios.

Si se actualizan las keys, se recomienda actualizar también translated para asegurar que cada término fuente tenga su traducción correspondiente.

Ejemplo

curl
1curl -X POST 'https://shangyiai.com/api/v1/glossary/update' \
2--header 'Authorization: [yourSecretKey]' \
3--header 'Content-Type: application/json' \
4--data '{
5  "glossaryId": "[string]",
6  "name": "0twXbd",
7  "keys": [
8    "储蓄分流"
9  ],
10  "translated": {
11    "储蓄分流": "Diversion of household deposits"
12  }
13}'

Parámetros de Solicitud

ParámetrosTipoPredeterminadoDescripciónEjemplo
*glossaryIdString-

ID del glosario de términos

-
nameString-

Nombre

Terminología financiera 2
descString-

Descripción

-
targetLangString-
  • Idioma de destino
  • Idiomas compatibles: consultar
-
keysString[]-

Matriz de todos los términos

["储蓄分流"]
translatedJSON-

Mapa de correspondencias de términos con sus traducciones

{"储蓄分流":"Diversion of household deposits"}

Respuesta

ParámetrosTipoPredeterminadoDescripciónEjemplo
glossaryIdString-

ID del glosario de términos

-
nameString-

Nombre

-
descString-

Descripción

-
targetLangString-

Idioma de destino

-
keysString[]-

Matriz de todos los términos

-
translatedJSON-

Mapa de correspondencias de términos con sus traducciones

-
createdAtDateTime-

Fecha de creación del glosario de términos

-
updatedAtDateTime-

Fecha de actualización del glosario de términos

-

Errores comunes

401 Missing API key.

The Authorization request header is required.

401 Invalid API key.

The API key does not exist, has been deleted, or is no longer valid.

400 Missing required parameter: glossaryId.

Provide the glossaryId returned by the create glossary API.

404 Glossary not found.

The glossary does not exist or does not belong to the current API account.

API de Glosario
Eliminar glosario