SelSup Developers

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

Configuración

Puntos finales para Configuraciones, incluidas rutas exactas, parámetros, cuerpos de solicitud y esquemas de respuesta expandibles.

3 puntos finales/api/propertyEstablesDescripció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/property

Flujos de trabajo listos para su uso

Flujos de trabajo listos para su uso

01

Comience con Configuraciones

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.

Property6 campos
organizationIdinteger · int64

Identificación de la organización.

clientIdinteger · int64

Identificación del cliente.

read-only
componentstring

Componente.

namestring

- ¿Cómo se llama?

valuestring

El valor.

valueNamestring

Nombre de valor.

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

Ponga en posesión

/api/property/
Token con acceso a escribir

Colocar Propiedad usando PUT /api/property/.

Organismo de solicitud

application/json
Campos de objetosProperty
CampoTipoObligatorioDescripción
organizationId integer · int64 No Identificación de la organización.
clientId integer · int64 No Identificación del cliente.
component string No Componente.
name string No - ¿Cómo se llama?
value string No El valor.
valueName string No Nombre de valor.
curl --request PUT 'https://api.selsup.ru/api/property/' \
  --header 'Authorization: YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "organizationId": 1001,
  "clientId": 1001,
  "component": "string",
  "name": "Example",
  "value": "string",
  "valueName": "Example"
}'

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_invalid_currency_source
La fuente de tipo de cambio especificada no es compatible

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

¡Vamos!

/api/property/{organizationId}/{component}
Token con acceso a lectura

Obtenga el uso de GET /api/property/{organizationId}/{component}.

Parámetros de trayectoria

CampoTipoObligatorioDescripción
organizationId integer · int64 Identificación de la organización.
component string Componente.
curl --request GET 'https://api.selsup.ru/api/property/1001/string' \
  --header 'Authorization: YOUR_API_TOKEN'

Respuesta exitosa

200
"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_header_logo_upload_failed
Could not upload the logo. Please try again.

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

400error_ozon_fbo_workflow_not_found
No se encontró el flujo Ozon FBO {id}

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

400error_user_does_not_have_this_organization
El usuario no tiene acceso a esta organización

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

GET

Lista de los productos

/api/property/list/{component}
Token con acceso a lectura

Lista con GET /api/property/list/{component}.

Parámetros de trayectoria

CampoTipoObligatorioDescripción
component string Componente.

Parámetros de consulta

CampoTipoObligatorioDescripción
organizationId integer · int64 No Identificación de la organización.
curl --request GET 'https://api.selsup.ru/api/property/list/string' \
  --header 'Authorization: YOUR_API_TOKEN'

Respuesta exitosa

200
Estructura de los elementos del array Property[]
CampoTipoObligatorioDescripción
organizationId integer · int64 No Identificación de la organización.
clientId integer · int64 No Identificación del cliente.
component string No Componente.
name string No - ¿Cómo se llama?
value string No El valor.
valueName string No Nombre de valor.
[
  "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_subscription_expired
Su tarifa ha expirado. Pague la tarifa para continuar usando el servicio.

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