SelSup Developers

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

Cuentas de facturación

Puntos finales de facturación, incluidas rutas exactas, parámetros, organismos de solicitud y esquemas de respuesta expansibles.

1 puntos finales/api/billing/findEstablesDescripció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/billing/find

Flujos de trabajo listos para su uso

Flujos de trabajo listos para su uso

01

Comience a usar la facturación

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.

Billing17 campos
idinteger · int64

Id.

namestring

- ¿Cómo se llama?

productIdinteger · int64

Identificación del producto.

itemIdinteger · int64

El artículo ID.

orderIdinteger · int64

El número de orden.

pricenumber · double

El precio.

volumeinteger · int32

El volumen.

weightinteger · int32

- ¿Qué peso?

quantityinteger · int32

La cantidad.

totalPricenumber · double

El precio total.

tariffIdinteger · int64

Identificación de los aranceles.

linkedClientIdinteger · int64

Identificación de cliente vinculada.

clientIdinteger · int64

Identificación del cliente.

fromstring · date-time

Desde.

tostring · date-time

- ¿Qué quieres?

datestring · date-time

- ¿Qué?

userIdinteger · int64

Identificación del usuario.

FindResponseBilling1 campos
rowsBilling[]

Las filas.

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 operación de facturación

/api/billing/find
Token con acceso a lectura

Obtenga la operación de facturación utilizando GET /api/billing/find.

Parámetros de consulta

CampoTipoObligatorioDescripción
from string · date-time No Desde.
to string · date-time No - ¿Qué quieres?
limit integer · int32 No El límite.
page integer · int32 No Página.
count boolean No Conde.
sortBy string No Se ha ordenado.
ascending boolean No Ascendiendo.
curl --request GET 'https://api.selsup.ru/api/billing/find?limit=50&page=1' \
  --header 'Authorization: YOUR_API_TOKEN'

Respuesta exitosa

200
Campos de objetos FindResponseBilling
CampoTipoObligatorioDescripción
rows Billing[] No Las filas.
Estructura de los elementos del array Billing
CampoTipoObligatorioDescripción
id integer · int64 No Id.
name string No - ¿Cómo se llama?
productId integer · int64 No Identificación del producto.
itemId integer · int64 No El artículo ID.
orderId integer · int64 No El número de orden.
price number · double No El precio.
volume integer · int32 No El volumen.
weight integer · int32 No - ¿Qué peso?
quantity integer · int32 No La cantidad.
totalPrice number · double No El precio total.
tariffId integer · int64 No Identificación de los aranceles.
linkedClientId integer · int64 No Identificación de cliente vinculada.
clientId integer · int64 No Identificación del cliente.
from string · date-time No Desde.
to string · date-time No - ¿Qué quieres?
date string · date-time No - ¿Qué?
userId integer · int64 No Identificación del usuario.
{
  "rows": "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_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_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.