SelSup Developers

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

Competidores

Los puntos finales para los competidores, incluidas las rutas exactas, los parámetros, los organismos de solicitud y los esquemas de respuesta expansibles.

4 puntos finales/api/competitorEstablesDescripció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/competitor

Flujos de trabajo listos para su uso

Flujos de trabajo listos para su uso

01

Comience a utilizar Competidores

Utilice un token API dedicado y valida primero las operaciones de lectura con los datos de prueba.

  1. Mantenga el token en el lado del servidor y envíelo en el encabezado Authorization.
  2. Verifique los parámetros requeridos y amplíe el esquema de solicitud o respuesta.
  3. Manejar el estado HTTP y el campo estable error en errores de aplicación.

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.

Competitor6 campos
idinteger · int64

Id.

read-only
modelIdinteger · int64

Identificación de modelo.

servicestring

Servicio.

Obligatorio
urlstring

- ¿Qué quieres?

Obligatorio
serviceIdstring

Identificación de servicio.

clientIdinteger · int64

Identificación del cliente.

read-only

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

PUT

Actualización

/api/competitor/{competitorId}
Token con acceso a escribir

Actualización con PUT /api/competitor/{competitorId}.

Parámetros de trayectoria

CampoTipoObligatorioDescripción
competitorId integer · int64 Identificación de competidor.

Organismo de solicitud

application/json
Campos de objetosCompetitor
CampoTipoObligatorioDescripción
id integer · int64 No Id.
modelId integer · int64 No Identificación de modelo.
service stringNONE, WILDBERRIES, OZON, YANDEX_MARKET, FAMILIYA, NATIONAL_CATALOG, ALIEXPRESS, OTHER, MOY_SKLAD, SBER_MEGA_MARKET, CISLINK, ONE_C, AVITO, LEROY_MERLIN, DETMIR, KAZAN_EXPRESS, EVOTOR, WEBASYST, AMAZON, EBAY, SIMALAND, INSALES, LAMODA, OZON_PERFORMANCE, WALMART, GOOGLE, YANDEX_DISC, EMAIL, WOOCOMMERCE, MAGNIT, OPENCART, M_VIDEO, TAKEALOT, UZUM, SHOPIFY, MAKRO, YANDEX_KIT, BOB_SHOP, KASPI, DIADOC Servicio.
url string - ¿Qué quieres?
serviceId string No Identificación de servicio.
clientId integer · int64 No Identificación del cliente.
curl --request PUT 'https://api.selsup.ru/api/competitor/1001' \
  --header 'Authorization: YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "service": "NONE",
  "url": "https://example.com",
  "id": 1001,
  "modelId": 1001,
  "serviceId": "string",
  "clientId": 1001
}'

Respuesta exitosa

200

La respuesta no tiene cuerpo.

Errores8

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_competitor_id_required
Se requiere id del competidor

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

400error_competitor_required
Competidor obligatorio

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

400error_competitor_service_required
El servicio del competidor es obligatorio

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

400error_competitor_url_required
El enlace del competidor es obligatorio

error específico de punto final. Utilice el código estable error_competitor_url_required 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.

DELETE

Eliminar

/api/competitor/{competitorId}
Token con acceso a escribir

Eliminar con DELETE /api/competitor/{competitorId}.

Parámetros de trayectoria

CampoTipoObligatorioDescripción
competitorId integer · int64 Identificación de competidor.
curl --request DELETE 'https://api.selsup.ru/api/competitor/1001' \
  --header 'Authorization: YOUR_API_TOKEN'

Respuesta exitosa

200

La respuesta no tiene cuerpo.

Errores5

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_competitor_id_required
Se requiere id del competidor

error específico de punto final. Utilice el código estable error_competitor_id_required 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

¡Toda la gente !

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

Obtenga todo usando GET /api/competitor/{modelId}.

Parámetros de trayectoria

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

Respuesta exitosa

200
Estructura de los elementos del array Competitor[]
CampoTipoObligatorioDescripción
id integer · int64 No Id.
modelId integer · int64 No Identificación de modelo.
service stringNONE, WILDBERRIES, OZON, YANDEX_MARKET, FAMILIYA, NATIONAL_CATALOG, ALIEXPRESS, OTHER, MOY_SKLAD, SBER_MEGA_MARKET, CISLINK, ONE_C, AVITO, LEROY_MERLIN, DETMIR, KAZAN_EXPRESS, EVOTOR, WEBASYST, AMAZON, EBAY, SIMALAND, INSALES, LAMODA, OZON_PERFORMANCE, WALMART, GOOGLE, YANDEX_DISC, EMAIL, WOOCOMMERCE, MAGNIT, OPENCART, M_VIDEO, TAKEALOT, UZUM, SHOPIFY, MAKRO, YANDEX_KIT, BOB_SHOP, KASPI, DIADOC Servicio.
url string - ¿Qué quieres?
serviceId string No Identificación de servicio.
clientId integer · int64 No Identificación del cliente.
[
  "string"
]
Errores5

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_model_id_required
Se requiere id del modelo

error específico de punto final. Utilice el código estable error_model_id_required 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.

POST

Crear

/api/competitor/{modelId}
Token con acceso a escribir

Crear con POST /api/competitor/{modelId}.

Parámetros de trayectoria

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

Organismo de solicitud

application/json
Campos de objetosCompetitor
CampoTipoObligatorioDescripción
id integer · int64 No Id.
modelId integer · int64 No Identificación de modelo.
service stringNONE, WILDBERRIES, OZON, YANDEX_MARKET, FAMILIYA, NATIONAL_CATALOG, ALIEXPRESS, OTHER, MOY_SKLAD, SBER_MEGA_MARKET, CISLINK, ONE_C, AVITO, LEROY_MERLIN, DETMIR, KAZAN_EXPRESS, EVOTOR, WEBASYST, AMAZON, EBAY, SIMALAND, INSALES, LAMODA, OZON_PERFORMANCE, WALMART, GOOGLE, YANDEX_DISC, EMAIL, WOOCOMMERCE, MAGNIT, OPENCART, M_VIDEO, TAKEALOT, UZUM, SHOPIFY, MAKRO, YANDEX_KIT, BOB_SHOP, KASPI, DIADOC Servicio.
url string - ¿Qué quieres?
serviceId string No Identificación de servicio.
clientId integer · int64 No Identificación del cliente.
curl --request POST 'https://api.selsup.ru/api/competitor/1001' \
  --header 'Authorization: YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "service": "NONE",
  "url": "https://example.com",
  "id": 1001,
  "modelId": 1001,
  "serviceId": "string",
  "clientId": 1001
}'

Respuesta exitosa

200
Campos de objetos Competitor
CampoTipoObligatorioDescripción
id integer · int64 No Id.
modelId integer · int64 No Identificación de modelo.
service stringNONE, WILDBERRIES, OZON, YANDEX_MARKET, FAMILIYA, NATIONAL_CATALOG, ALIEXPRESS, OTHER, MOY_SKLAD, SBER_MEGA_MARKET, CISLINK, ONE_C, AVITO, LEROY_MERLIN, DETMIR, KAZAN_EXPRESS, EVOTOR, WEBASYST, AMAZON, EBAY, SIMALAND, INSALES, LAMODA, OZON_PERFORMANCE, WALMART, GOOGLE, YANDEX_DISC, EMAIL, WOOCOMMERCE, MAGNIT, OPENCART, M_VIDEO, TAKEALOT, UZUM, SHOPIFY, MAKRO, YANDEX_KIT, BOB_SHOP, KASPI, DIADOC Servicio.
url string - ¿Qué quieres?
serviceId string No Identificación de servicio.
clientId integer · int64 No Identificación del cliente.
{
  "service": "NONE",
  "url": "https://example.com",
  "id": 1001,
  "modelId": 1001,
  "serviceId": "string",
  "clientId": 1001
}
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_competitor_required
Competidor obligatorio

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

400error_competitor_service_required
El servicio del competidor es obligatorio

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

400error_competitor_url_required
El enlace del competidor es obligatorio

error específico de punto final. Utilice el código estable error_competitor_url_required 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.

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.