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.
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
01
Comience con las palabras clave
Utilice un token API dedicado y valida primero las operaciones de lectura con los datos de prueba.
Mantenga el token en el lado del servidor y envíelo en el encabezado Authorization.
Verifique los parámetros requeridos y amplíe el esquema de solicitud o respuesta.
Manejar el estado HTTP y el campo estable error en errores de aplicación.
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
Campo
Tipo
Obligatorio
Descripción
groupId
integer · int64
Sí
Identificación de grupo.
curl --request GET 'https://api.selsup.ru/api/keyword/group/1001' \
--header 'Authorization: YOUR_API_TOKEN'
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.
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
Campo
Tipo
Obligatorio
Descripción
modelId
integer · int64
Sí
Identificación de modelo.
curl --request GET 'https://api.selsup.ru/api/keyword/1001' \
--header 'Authorization: YOUR_API_TOKEN'