Ir al contenido principal

Валантис

API

Autenticación

Аутентификацияde запросов.

solicitudes

АутентификацияLa запросовautenticación происходитde заsolicitudes счетse авторизационнойrealiza строки,mediante котораяuna передаетсяcadena вde параметреautorización, заголовкаque se pasa en el parámetro del encabezado X-Auth.
ЗначениеEl valor de X-Auth se формируетсяforma поsegún следующемуla шаблону:siguiente plantilla: md5(пароль_таймштамп)contraseña_sello_de_tiempo).
ТаймштампEl представляетsello собойde текущуюtiempo датуrepresenta la fecha actual en UTC сcon точностьюprecisión доde дняdía вen форматеel год,formato месяц,año, деньmes, безdía разделителей.sin separadores.
ПарольLa иcontraseña таймштампy разделяютсяel символомsello подчеркивания.de tiempo se separan con el carácter de subrayado.
Пример:Ejemplo: md5("password_20230821").
ВEn случае,caso еслиde авторизационнаяque строкаla сформированаcadena некорректно,de будетautorización возвращенse forme incorrectamente, se devolverá el código HTTP код 401.

Методы.Métodos

РаботаEl сtrabajo con el API осуществляетсяse черезrealiza a través de POST en наla указанныйdirección адресy иpuerto порт.indicados.
ТелоEl запросаcuerpo представляетde собойla jsonsolicitud содержащийes имяun методаJSON que contiene el nombre del método action y иun опциональныйconjunto наборopcional параметровde parámetros params.
Пример:

Ejemplo

{
	"action": "filter",
	"params": {"price": 17500.0}
}

Si
la

Еслиsolicitud запросno неcontiene содержитerrores, ошибок,se наrecibe негоuna приходитrespuesta синхронныйsincrónica ответen в форматеformato JSON.
РезультатEl работыresultado методаdel возвращаетсяmétodo поse ключуdevuelve bajo la clave result.
Пример:


Ejemplo:

{
    "result": [
        "59a9b5b4-6546-417f-9c0a-7ec1b9385af1",
        "271aa4c2-70be-4a03-9e20-1fbebb2aa79f",
        "12d19cdd-a58a-41bf-b387-3c8c3d08a40a",
    ]
}

Si


la
solicitud

Еслиcontiene вerrores, запросеse содержатьсяdevolverá ошибки,el то будет возвращенcódigo HTTP код 400400.

get_ids - методel возвращаетmétodo упорядоченныйdevuelve списокuna идентификаторовlista товаров.ordenada de identificadores de productos.
ДалееA поcontinuación, выбраннымse идентификаторамpuede можноsolicitar запроситьinformación подробнуюdetallada информациюsobre оel товаре.producto usando los identificadores seleccionados.
ПоPor умолчаниюdefecto, возвращаетdevuelve идентификаторыlos всехidentificadores имеющиесяde товаров.todos los productos disponibles.
Параметры:Parámetros:
offset  - положительноеnúmero целоеentero число.positivo. ОпределяетDetermina смещениеel относительноdesplazamiento началаrelativo списка.al inicio de la lista.
limit  - положительноеnúmero целоеentero число.positivo. ОпределяетDetermina желаемоеel числоnúmero возвращаемыхdeseado записей.

de registros a devolver.

ПримерEjemplo запроса:de solicitud:

{
	"action": "get_ids",
	"params": {"offset": 10, "limit": 3}
}

ПримерEjemplo ответа:de respuesta:

{
    "result": [
        "18e4e3bd-5e60-4348-8c92-4f61c676be1f",
        "711837ec-57f6-4145-b17f-c74c2896bafe",
        "6c972a4a-5b91-4a98-9780-3a19a7f41560"
    ]
}

get_items - возвращаетdevuelve упорядоченныйuna списокlista товаровordenada соde всемиproductos характеристиками,con еслиtodas переданыsus идентификаторыcaracterísticas товаров.si se proporcionan los identificadores de los productos.
МаксимумMáximo de 100 registros.
Si записей.
Еслиse нужноnecesita получитьobtener болееmás de 100, необходимоes выполнитьnecesario запросrealizar несколькоla раз.solicitud Безvarias передачиveces. идентификаторовSin возвращаетproporcionar nulllos identificadores, devuelve null.


ПараметрыParámetros:
ids - упорядоченныйlista списокordenada строк.de Определяетcadenas. идентификаторыDetermina товаров,los которыеidentificadores будутde возвращены.los productos que serán devueltos.

Ejemplo de solicitud:
Пример запроса:

{
    "action": "get_items",
    "params": {"ids": ["1789ecf3-f81c-4f49-ada2-83804dcc74b0"]}
}

ПримерEjemplo ответа:de respuesta:

{
    "result": [
        {
            "brand": null,
            "id": "1789ecf3-f81c-4f49-ada2-83804dcc74b0",
            "price": 16700.0,
            "product": "Золотоеun кольцоanillo сcon бриллиантами"un diamante"
        }
    ]
}

get_fields - безsin параметровparámetros, возвращаетdevuelve упорядоченныйuna списокlista имеющихсяordenada полейde товаров.los campos disponibles de los productos.
ПриAl передачеproporcionar параметраel fieldparámetro возвращаетfield, упорядоченныйdevuelve списокuna значенийlista данногоordenada поляde товаров.los valores de ese campo de los productos.
Параметры:Parámetros:
field  - строка.cadena Должнаde содержатьtexto. действительноеDebe названиеcontener поляel товара.nombre válido del campo del producto.
offset  - положительноеnúmero целоеentero число.positivo. ОпределяетDetermina смещениеel относительноdesplazamiento началаrelativo списка.al inicio de la lista.
limit  - положительноеnúmero целоеentero число.positivo. ОпределяетDetermina желаемоеel числоnúmero возвращаемыхdeseado записей.de registros a devolver.


ПримерEjemplo запроса:de solicitud:

{
    "action": "get_fields",
    "params": {"field": "brand", "offset": 3, "limit": 5}
}

ПримерEjemplo ответа:de respuesta:

{
    "result": [
        null,
        null,
        "Piaget",
        null,
        null
    ]
}

filter  - используетсяse дляutiliza фильтрации.para filtrar.
ВозвращаетDevuelve упорядоченныйuna списокlista идентификаторовordenada товаров,de соответствующихidentificadores заданномуde значению.productos que corresponden al valor especificado.
Параметры:Parámetros:
ВSe качествеpuede параметраusar можетcualquier использоватьсяcampo любоеdevuelto полеpor возвращаемоеel методомmétodo get_fields безsin параметров.parámetros como parámetro.
ВEl качествеvalor значенияdebe долженser использоватьсяdel типtipo данныхde соответствующийdatos полю.correspondiente al campo.
ДляPara поляel productcampo будетproduct, проверятьсяse вхождениеverificará параметраla вinclusión строку.del parámetro en la cadena.
ДляPara остальныхlos полейdemás проверяетсяcampos, строгоеse соответствие.verifica una coincidencia exacta.

Ejemplo de solicitud:
Пример запроса:

{
    "action": "filter",
    "params": {"price": 17500.0}
}

ПримерEjemplo ответа:de respuesta:

{
    "result": [
        "59a9b5b4-6546-417f-9c0a-7ec1b9385af1",
        "271aa4c2-70be-4a03-9e20-1fbebb2aa79f",
    ]
}

Volver arriba