SelSup Developers

El proyecto de ley de la Unión Europea · API Referencia

Palabras clave

Puntos finales para las palabras clave, incluidas las rutas exactas, los parámetros, los organismos de solicitud y los esquemas de respuesta expandibles.

12 puntos finales/api/keywordEstablesDescripción legible por máquina ↗
{ }

Esta página está respaldada por un contrato independiente editable. Valida las operaciones de escritura con datos de prueba antes de su uso en producción.

/api/keyword

Flujos de trabajo listos para su uso

Flujos de trabajo listos para su uso

Modelo de datos

Estructuras de datos

Los modelos se enumeran una vez aquí y también se pueden ampliar directamente desde los puntos finales que los utilizan.

Keyword3 campos
idinteger · int64

Id.

namestring

- ¿Cómo se llama?

usingQuantityinteger · int32

Usando la cantidad.

KeywordGroup3 campos
idinteger · int64

Id.

namestring

- ¿Cómo se llama?

keywordsKeyword[]

Palabras clave.

KeywordAndGroup2 campos
keywordKeyword[]

Es la palabra clave.

groupKeywordGroup[]

Grupo.

Contrato de error

Cómo se devuelven los errores de aplicación

El código error es idéntico en todas las localizaciones, mientras que el mensaje orientado al usuario es traducido por el servidor.

Exproteccion

Código estable legible por máquina para la lógica de integración.

Exproteccion

Mensaje listo para la pantalla en el idioma del usuario de tokens API.

Exproteccion

Valores interpolados por el servidor en la plantilla de mensaje localizado.

localMessage utiliza el campo lang del usuario que posee el token API. El lenguaje de documentación y el encabezado Accept-Language no lo cambian; el ruso se utiliza cuando el usuario no tiene un idioma configurado.

RUEl lugar del usuario es ru
{
  "error": "error_brand_already_exists",
  "localMessage": "Бренд Base уже существует",
  "params": {
    "name": "Base"
  }
}
ESEspañol (es)
{
  "error": "error_brand_already_exists",
  "localMessage": "La marca Base ya existe",
  "params": {
    "name": "Base"
  }
}

Puntos finales

Puntos finales

GET

Obtenga la palabra clave del grupo

/api/keyword/group/{groupId}
Token con acceso a lectura

Obtenga la palabra clave de un grupo usando GET /api/keyword/group/{groupId}.

Parámetros de trayectoria

CampoTipoObligatorioDescripción
groupId integer · int64 Identificación de grupo.
curl --request GET 'https://api.selsup.ru/api/keyword/group/1001' \
  --header 'Authorization: YOUR_API_TOKEN'

Respuesta exitosa

200
Campos de objetos KeywordGroup
CampoTipoObligatorioDescripción
id integer · int64 No Id.
name string No - ¿Cómo se llama?
keywords Keyword[] No Palabras clave.
Estructura de los elementos del array Keyword
CampoTipoObligatorioDescripción
id integer · int64 No Id.
name string No - ¿Cómo se llama?
usingQuantity integer · int32 No Usando la cantidad.
{
  "id": 1001,
  "name": "Example",
  "keywords": "string"
}
Errores3

Los errores de aplicación se devuelven normalmente como JSON con error, localMessage y params. Cómo se devuelven los errores de aplicación ↑

401auth_required
Se requiere la autenticación

Authorization está faltando, vacío o contiene un token inválido.

400error_access_denied
Acceso denegado

El token existe, pero su papel no puede realizar esta operación.

500error_unknown
Ocurrió un error desconocido. Si el problema persiste, escriba al servicio de soporte

Fallo interno: ahorra tiempo en la solicitud y apoyo de contacto; no vuelva a intentar una mutación ciegamente.

PUT

Editar el grupo de palabras clave por ID

/api/keyword/group/{groupId}
Token con acceso a escribir

Editar el grupo de palabras clave por ID usando PUT /api/keyword/group/{groupId}.

Parámetros de trayectoria

CampoTipoObligatorioDescripción
groupId integer · int64 Identificación de grupo.

Parámetros de consulta

CampoTipoObligatorioDescripción
newName string No Nuevo nombre.

Organismo de solicitud

application/json
curl --request PUT 'https://api.selsup.ru/api/keyword/group/1001' \
  --header 'Authorization: YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '[
  "string"
]'

Respuesta exitosa

200
Campos de objetos KeywordGroup
CampoTipoObligatorioDescripción
id integer · int64 No Id.
name string No - ¿Cómo se llama?
keywords Keyword[] No Palabras clave.
Estructura de los elementos del array Keyword
CampoTipoObligatorioDescripción
id integer · int64 No Id.
name string No - ¿Cómo se llama?
usingQuantity integer · int32 No Usando la cantidad.
{
  "id": 1001,
  "name": "Example",
  "keywords": "string"
}
Errores3

Los errores de aplicación se devuelven normalmente como JSON con error, localMessage y params. Cómo se devuelven los errores de aplicación ↑

401auth_required
Se requiere la autenticación

Authorization está faltando, vacío o contiene un token inválido.

400error_access_denied
Acceso denegado

El token existe, pero su papel no puede realizar esta operación.

500error_unknown
Ocurrió un error desconocido. Si el problema persiste, escriba al servicio de soporte

Fallo interno: ahorra tiempo en la solicitud y apoyo de contacto; no vuelva a intentar una mutación ciegamente.

DELETE

Eliminar el grupo de palabras clave

/api/keyword/group/{groupId}
Token con acceso a escribir

Eliminar el grupo de palabras clave usando DELETE /api/keyword/group/{groupId}.

Parámetros de trayectoria

CampoTipoObligatorioDescripción
groupId integer · int64 Identificación de grupo.
curl --request DELETE 'https://api.selsup.ru/api/keyword/group/1001' \
  --header 'Authorization: YOUR_API_TOKEN'

Respuesta exitosa

200
Campos de objetos KeywordGroup
CampoTipoObligatorioDescripción
id integer · int64 No Id.
name string No - ¿Cómo se llama?
keywords Keyword[] No Palabras clave.
Estructura de los elementos del array Keyword
CampoTipoObligatorioDescripción
id integer · int64 No Id.
name string No - ¿Cómo se llama?
usingQuantity integer · int32 No Usando la cantidad.
{
  "id": 1001,
  "name": "Example",
  "keywords": "string"
}
Errores3

Los errores de aplicación se devuelven normalmente como JSON con error, localMessage y params. Cómo se devuelven los errores de aplicación ↑

401auth_required
Se requiere la autenticación

Authorization está faltando, vacío o contiene un token inválido.

400error_access_denied
Acceso denegado

El token existe, pero su papel no puede realizar esta operación.

500error_unknown
Ocurrió un error desconocido. Si el problema persiste, escriba al servicio de soporte

Fallo interno: ahorra tiempo en la solicitud y apoyo de contacto; no vuelva a intentar una mutación ciegamente.

PUT

Añadir grupo de palabras clave

/api/keyword/add
Token con acceso a escribir

Añadir el grupo de palabras clave con PUT /api/keyword/add.

Parámetros de consulta

CampoTipoObligatorioDescripción
productId integer · int64 No Identificación del producto.
productViewId integer · int64 No Identificación de la vista del producto.
modelId integer · int64 No Identificación de modelo.

Organismo de solicitud

application/json
curl --request PUT 'https://api.selsup.ru/api/keyword/add' \
  --header 'Authorization: YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '[
  1
]'

Respuesta exitosa

200

La respuesta no tiene cuerpo.

Errores3

Los errores de aplicación se devuelven normalmente como JSON con error, localMessage y params. Cómo se devuelven los errores de aplicación ↑

401auth_required
Se requiere la autenticación

Authorization está faltando, vacío o contiene un token inválido.

400error_access_denied
Acceso denegado

El token existe, pero su papel no puede realizar esta operación.

500error_unknown
Ocurrió un error desconocido. Si el problema persiste, escriba al servicio de soporte

Fallo interno: ahorra tiempo en la solicitud y apoyo de contacto; no vuelva a intentar una mutación ciegamente.

GET

Obtenga el grupo de palabras clave

/api/keyword/group
Token con acceso a lectura

Obtenga el grupo de palabras clave usando GET /api/keyword/group.

curl --request GET 'https://api.selsup.ru/api/keyword/group' \
  --header 'Authorization: YOUR_API_TOKEN'

Respuesta exitosa

200
Estructura de los elementos del array KeywordGroup[]
CampoTipoObligatorioDescripción
id integer · int64 No Id.
name string No - ¿Cómo se llama?
keywords Keyword[] No Palabras clave.
Estructura de los elementos del array Keyword
CampoTipoObligatorioDescripción
id integer · int64 No Id.
name string No - ¿Cómo se llama?
usingQuantity integer · int32 No Usando la cantidad.
[
  "string"
]
Errores4

Los errores de aplicación se devuelven normalmente como JSON con error, localMessage y params. Cómo se devuelven los errores de aplicación ↑

401auth_required
Se requiere la autenticación

Authorization está faltando, vacío o contiene un token inválido.

400error_access_denied
Acceso denegado

El token existe, pero su papel no puede realizar esta operación.

500error_unknown
Ocurrió un error desconocido. Si el problema persiste, escriba al servicio de soporte

Fallo interno: ahorra tiempo en la solicitud y apoyo de contacto; no vuelva a intentar una mutación ciegamente.

400error_no_client
Cliente no encontrado o fue eliminado. Escriba al soporte

error específico de punto final. Utilice el código estable error_no_client en la lógica de la aplicación; localMessage contiene la traducción mostrada anteriormente.

POST

Crear un grupo de palabras clave

/api/keyword/group
Token con acceso a escribir

Crea un grupo de palabras clave usando POST /api/keyword/group.

Parámetros de consulta

CampoTipoObligatorioDescripción
groupName string Nombre del grupo.

Organismo de solicitud

application/json
curl --request POST 'https://api.selsup.ru/api/keyword/group?groupName=Example' \
  --header 'Authorization: YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '[
  "string"
]'

Respuesta exitosa

200
Campos de objetos KeywordGroup
CampoTipoObligatorioDescripción
id integer · int64 No Id.
name string No - ¿Cómo se llama?
keywords Keyword[] No Palabras clave.
Estructura de los elementos del array Keyword
CampoTipoObligatorioDescripción
id integer · int64 No Id.
name string No - ¿Cómo se llama?
usingQuantity integer · int32 No Usando la cantidad.
{
  "id": 1001,
  "name": "Example",
  "keywords": "string"
}
Errores3

Los errores de aplicación se devuelven normalmente como JSON con error, localMessage y params. Cómo se devuelven los errores de aplicación ↑

401auth_required
Se requiere la autenticación

Authorization está faltando, vacío o contiene un token inválido.

400error_access_denied
Acceso denegado

El token existe, pero su papel no puede realizar esta operación.

500error_unknown
Ocurrió un error desconocido. Si el problema persiste, escriba al servicio de soporte

Fallo interno: ahorra tiempo en la solicitud y apoyo de contacto; no vuelva a intentar una mutación ciegamente.

DELETE

Eliminar los grupos de palabras clave

/api/keyword/group
Token con acceso a escribir

Eliminar los grupos de palabras clave usando DELETE /api/keyword/group.

Organismo de solicitud

application/json
curl --request DELETE 'https://api.selsup.ru/api/keyword/group' \
  --header 'Authorization: YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '[
  1
]'

Respuesta exitosa

200
"string"
Errores3

Los errores de aplicación se devuelven normalmente como JSON con error, localMessage y params. Cómo se devuelven los errores de aplicación ↑

401auth_required
Se requiere la autenticación

Authorization está faltando, vacío o contiene un token inválido.

400error_access_denied
Acceso denegado

El token existe, pero su papel no puede realizar esta operación.

500error_unknown
Ocurrió un error desconocido. Si el problema persiste, escriba al servicio de soporte

Fallo interno: ahorra tiempo en la solicitud y apoyo de contacto; no vuelva a intentar una mutación ciegamente.

POST

Combine los grupos de palabras clave

/api/keyword/group/merge
Token con acceso a escribir

Combine grupos de palabras clave usando POST /api/keyword/group/merge.

Parámetros de consulta

CampoTipoObligatorioDescripción
newGroupName string Nuevo nombre de grupo.

Organismo de solicitud

application/json
curl --request POST 'https://api.selsup.ru/api/keyword/group/merge?newGroupName=Example' \
  --header 'Authorization: YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '[
  1
]'

Respuesta exitosa

200
Campos de objetos KeywordGroup
CampoTipoObligatorioDescripción
id integer · int64 No Id.
name string No - ¿Cómo se llama?
keywords Keyword[] No Palabras clave.
Estructura de los elementos del array Keyword
CampoTipoObligatorioDescripción
id integer · int64 No Id.
name string No - ¿Cómo se llama?
usingQuantity integer · int32 No Usando la cantidad.
{
  "id": 1001,
  "name": "Example",
  "keywords": "string"
}
Errores7

Los errores de aplicación se devuelven normalmente como JSON con error, localMessage y params. Cómo se devuelven los errores de aplicación ↑

401auth_required
Se requiere la autenticación

Authorization está faltando, vacío o contiene un token inválido.

400error_access_denied
Acceso denegado

El token existe, pero su papel no puede realizar esta operación.

500error_unknown
Ocurrió un error desconocido. Si el problema persiste, escriba al servicio de soporte

Fallo interno: ahorra tiempo en la solicitud y apoyo de contacto; no vuelva a intentar una mutación ciegamente.

400error_empty_group_name
El nombre del grupo de palabras clave no puede estar vacío

error específico de punto final. Utilice el código estable error_empty_group_name en la lógica de la aplicación; localMessage contiene la traducción mostrada anteriormente.

400error_empty_keywords_groups
El grupo de palabras clave está vacío

error específico de punto final. Utilice el código estable error_empty_keywords_groups en la lógica de la aplicación; localMessage contiene la traducción mostrada anteriormente.

400error_need_at_least_two_groups
se necesitan al menos dos grupos

error específico de punto final. Utilice el código estable error_need_at_least_two_groups en la lógica de la aplicación; localMessage contiene la traducción mostrada anteriormente.

400error_no_client
Cliente no encontrado o fue eliminado. Escriba al soporte

error específico de punto final. Utilice el código estable error_no_client en la lógica de la aplicación; localMessage contiene la traducción mostrada anteriormente.

GET

Obtenga la palabra clave para entidad

/api/keyword/{modelId}
Token con acceso a lectura

Obtenga la palabra clave para la entidad usando GET /api/keyword/{modelId}.

Parámetros de trayectoria

CampoTipoObligatorioDescripción
modelId integer · int64 Identificación de modelo.
curl --request GET 'https://api.selsup.ru/api/keyword/1001' \
  --header 'Authorization: YOUR_API_TOKEN'

Respuesta exitosa

200
Campos de objetos KeywordAndGroup
CampoTipoObligatorioDescripción
keyword Keyword[] No Es la palabra clave.
Estructura de los elementos del array Keyword
CampoTipoObligatorioDescripción
id integer · int64 No Id.
name string No - ¿Cómo se llama?
usingQuantity integer · int32 No Usando la cantidad.
group KeywordGroup[] No Grupo.
Estructura de los elementos del array KeywordGroup
CampoTipoObligatorioDescripción
id integer · int64 No Id.
name string No - ¿Cómo se llama?
keywords Keyword[] No Palabras clave.
Estructura de los elementos del array Keyword
CampoTipoObligatorioDescripción
id integer · int64 No Id.
name string No - ¿Cómo se llama?
usingQuantity integer · int32 No Usando la cantidad.
{
  "keyword": "string",
  "group": "string"
}
Errores3

Los errores de aplicación se devuelven normalmente como JSON con error, localMessage y params. Cómo se devuelven los errores de aplicación ↑

401auth_required
Se requiere la autenticación

Authorization está faltando, vacío o contiene un token inválido.

400error_access_denied
Acceso denegado

El token existe, pero su papel no puede realizar esta operación.

500error_unknown
Ocurrió un error desconocido. Si el problema persiste, escriba al servicio de soporte

Fallo interno: ahorra tiempo en la solicitud y apoyo de contacto; no vuelva a intentar una mutación ciegamente.

GET

Encuentra el grupo de palabras clave

/api/keyword/group/find
Token con acceso a lectura

Encuentra el grupo de palabras clave usando GET /api/keyword/group/find.

Parámetros de consulta

CampoTipoObligatorioDescripción
word string - ¿Qué dices?
curl --request GET 'https://api.selsup.ru/api/keyword/group/find?word=string' \
  --header 'Authorization: YOUR_API_TOKEN'

Respuesta exitosa

200
Estructura de los elementos del array KeywordGroup[]
CampoTipoObligatorioDescripción
id integer · int64 No Id.
name string No - ¿Cómo se llama?
keywords Keyword[] No Palabras clave.
Estructura de los elementos del array Keyword
CampoTipoObligatorioDescripción
id integer · int64 No Id.
name string No - ¿Cómo se llama?
usingQuantity integer · int32 No Usando la cantidad.
[
  "string"
]
Errores3

Los errores de aplicación se devuelven normalmente como JSON con error, localMessage y params. Cómo se devuelven los errores de aplicación ↑

401auth_required
Se requiere la autenticación

Authorization está faltando, vacío o contiene un token inválido.

400error_access_denied
Acceso denegado

El token existe, pero su papel no puede realizar esta operación.

500error_unknown
Ocurrió un error desconocido. Si el problema persiste, escriba al servicio de soporte

Fallo interno: ahorra tiempo en la solicitud y apoyo de contacto; no vuelva a intentar una mutación ciegamente.

DELETE

Eliminar el grupo de palabras clave de la entidad

/api/keyword/model/{modelId}
Token con acceso a escribir

Eliminar el grupo de palabras clave de la entidad usando DELETE /api/keyword/model/{modelId}.

Parámetros de trayectoria

CampoTipoObligatorioDescripción
modelId integer · int64 Identificación de modelo.

Organismo de solicitud

application/json
curl --request DELETE 'https://api.selsup.ru/api/keyword/model/1001' \
  --header 'Authorization: YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '[
  1
]'

Respuesta exitosa

200
"string"
Errores3

Los errores de aplicación se devuelven normalmente como JSON con error, localMessage y params. Cómo se devuelven los errores de aplicación ↑

401auth_required
Se requiere la autenticación

Authorization está faltando, vacío o contiene un token inválido.

400error_access_denied
Acceso denegado

El token existe, pero su papel no puede realizar esta operación.

500error_unknown
Ocurrió un error desconocido. Si el problema persiste, escriba al servicio de soporte

Fallo interno: ahorra tiempo en la solicitud y apoyo de contacto; no vuelva a intentar una mutación ciegamente.

DELETE

Eliminar la palabra clave del grupo

/api/keyword/group/{groupId}/keywords
Token con acceso a escribir

Eliminar la palabra clave del grupo usando DELETE /api/keyword/group/{groupId}/keywords.

Parámetros de trayectoria

CampoTipoObligatorioDescripción
groupId integer · int64 Identificación de grupo.

Organismo de solicitud

application/json
curl --request DELETE 'https://api.selsup.ru/api/keyword/group/1001/keywords' \
  --header 'Authorization: YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '[
  1
]'

Respuesta exitosa

200
"string"
Errores3

Los errores de aplicación se devuelven normalmente como JSON con error, localMessage y params. Cómo se devuelven los errores de aplicación ↑

401auth_required
Se requiere la autenticación

Authorization está faltando, vacío o contiene un token inválido.

400error_access_denied
Acceso denegado

El token existe, pero su papel no puede realizar esta operación.

500error_unknown
Ocurrió un error desconocido. Si el problema persiste, escriba al servicio de soporte

Fallo interno: ahorra tiempo en la solicitud y apoyo de contacto; no vuelva a intentar una mutación ciegamente.

Authorization

Token para las solicitudes de ensayo

El token se queda en el localStorage de este navegador y se envía solo en el encabezado Authorization de las solicitudes a api.selsup.ru.

Probar

Parámetros reales de la solicitud

Respuesta en vivo API

Envía una solicitud para ver la respuesta SelSup.