Меню

Interacción con el PIX Master a través de la API

Conexión con el Swagger
Swagger – una herramienta para escribir funciones de API.
No se necesitan conocimientos especiales para generar consultas en Swagger: basta con especificar los parámetros necesarios.

Conectar Swagger
En el archivo appsettings.json (C:\Master\appsettings.json), establece el parámetro UseSwagger en true:

En Linux, abra el archivo
/etc/systemd/system/Master.service y en la línea Environment cambiar la palabra Production por Development.

A continuación, debe reiniciarse el servidor:


Lanzamiento del Swagger
Abra el Master y escriba /swagger al final de la URL:

Para escribir una consulta, basta con seleccionar la función deseada y hacer clic en Probar.

Ahora puede (1) especificar parámetros y (2) generar una consulta:


API de solicitud de token (TokenApi)
Genera un token único para interactuar con el PIX Master.
Importante! La token es válida durante 2 horas.

Es conveniente formar solicitudes de API en Swagger ( instrucciones sobre cómo conectarse).
Debe hacer clic en Pruébelo en la esquina superior derecha, aparecerán los campos para ingresar el nombre de usuario y la contraseña del PIX Master.

Después de la confirmación ( Execute) , aparecerá la solicitud API generada (1, 2) y
la respuesta a la solicitud "access_token" (3) .

Ejemplo de solicitud:

//Sustituir username y contraseña
//CURL
curl -X 'POST' \
  'https://nb063319.int.bit.ru:44300/api/Token?username=admin&password=Admin1Default%40' \
  -H 'accept: */*' \
  -d ''

//Request URL
"https://nb063319.int.bit.ru:44300/api/Token?username=admin&password=Admin1Default%40"
El token se puede obtener sin autorización, por lo que Swagger devuelve inmediatamente el resultado de la solicitud (3).

Por ejemplo, para solicitudes de API, puede usar la aplicación Postman (debe instalar el programa en su computadora).
Para obtener un token, seleccione el comando POST y pegue el enlace (URL) generado en Swagger .
Si se produce un error después de enviar la solicitud (1), deshabilite la verificación del certificado (2).

El resultado es un access_token, que deberá especificarse para otras consultas.


API de tareas (TasksApi)

Es conveniente formar solicitudes de API en Swagger ( instrucciones sobre cómo conectarse).
Obtener una lista de tareas: Funciona en versiones de Master posteriores a la 1.18.
Para obtener una lista de todas las tareas, debe escribir en el siguiente enlace la URL para conectarse al asistente:

// Especifique el enlace para ejecutar el Master

// URL
'Master link/api/Tasks/GetTaskList'
La solicitud de API se puede realizar en la aplicación Postman (es necesario instalar el programa en su computadora).

Para ello, (1) seleccione la función (GET), inserte el enlace generado y autorice por token ( Token Request API ).

La respuesta es JSON con toda la información sobre las tareas.
Iniciar una tarea por ID. Para generar una solicitud en Swagger, debe hacer clic en Pruébelo en la esquina superior derecha, aparecerá un campo para ingresar la identificación de la tarea . El ID de la tarea se puede ver en el asistente o puede usar la solicitud descrita anteriormente para obtener una lista de tareas.

Después de la confirmación ( Ejecutar) , aparecerá la solicitud API generada.

Puede usar una plantilla de solicitud especificando los parámetros necesarios allí:

// Especifique el enlace para ejecutar el asistente y el ID de la tarea (sin comillas)
// CURL
curl -X 'POST' \
  'Enlace para trabajar con el Master"/api/Tasks/StartTask?taskId=ID tareas' \
  -H 'accept: */*' \
  -d ''

// URL
'Enlace para trabajar con el Master/api/Tasks/StartTask?taskId=ID tareas'
Para realizar una solicitud en Postman (1) seleccione la función (POST), inserte el enlace generado y autorice por token ( Token Request API ).

La consulta a la API dará lugar a una respuesta codificada:

Iniciar una tarea por nombre. Funciona en versiones del Master posteriores a la 1.18.
Para iniciar la tarea, debe introducir un nombre en el enlace:

// Especifique el enlace para ejecutar el asistente y el nombre de la tarea 

// URL
'Enlace para trabajar con el Master/api/Tasks/StartTask?taskName=name'
Ejecutar una tarea en Postman se realiza de la siguiente manera:

Detener la tarea. Se introduce un ID de tarea.

Tras la confirmación (Ejecutar), aparecerá la solicitud de API generada.

// Especifique el enlace para ejecutar el Master y el ID de la tarea (sin comillas)
// CURL
curl -X 'POST' \
  'Enlace para trabajar con el Master/api/Tasks/StopTask?taskId=ID tarea' \
  -H 'accept: */*' \
  -d ''

// URL
'Enlace para trabajar con el Master/api/Tasks/StopTask?taskId=ID tarea'

API de procesos (ProcessesApi)
Inicio de un proceso en PIX Master.

Es conveniente formar solicitudes de API en Swagger ( instrucciones sobre cómo conectarse).
Inicio de un proceso. Debe hacer clic en Pruébelo en la esquina superior derecha, aparecerá un campo para ingresar el ID del proceso . El ID del proceso se puede encontrar en la base de datos utilizada, como PostgreSQL.

Tras la confirmación (Ejecutar), aparecerá la solicitud de API generada:

Swagger genera automáticamente el enlace.
Puede utilizar este código especificando el enlace para iniciar el Master y el ID del proceso (sin las comillas):

// CURL
curl -X 'POST' \
  '"Enlace para trabajar con el Master"/api/Processes/StartProcess?processId="ID el proceso"' \
  -H 'accept: */*' \
  -d ''

// URL
'"Enlace para trabajar con el Master"/api/Processes/StartProcess?processId="ID el proceso"'

La solicitud de API se puede realizar en la aplicación Postman (es necesario instalar el programa en su computadora).
Para hacer esto, debe iniciar sesión con un token ( Token Request API ), seleccione el comando POST y pegue el enlace (URL) generado en Swagger.

API de datos (DataApi)
Obtener/establecer un valor de datos.

Es conveniente formar solicitudes de API en Swagger ( instrucciones sobre cómo conectarse).
Hay 4 opciones disponibles:

Recuperar datos por su identificador.
Para generar una consulta en Swagger, debe especificar el ID de los datos.
Puede sustituir los valores deseados en la consulta generada:

//Curl
curl -X 'GET' \
  '"Enlace para trabajar con el Master"/api/Data/GetValueById?dataId=7' \
  -H 'accept: text/plain'

//Request URL
"Enlace para trabajar con el Master"/api/Data/GetValueById?dataId=7
La solicitud de API se puede realizar en la aplicación Postman (es necesario instalar el programa en su computadora).
Para ello, seleccione el comando (1) GET, inserte el enlace (URL) generado en Swagger y (2-3) autorice por token ( Token Request API ).

El resultado es un valor.

Recuperación de datos por su clave.
Для формирования запроса в Swagger надо указать ключ данных.
Можно подставить нужные значения (ссылку для работы с мастером и ключ) в сформированном запросе:

//Curl
  '"Enlace para trabajar con el Master"/api/Data/GetValueByKey?key=Key' \
  -H 'accept: text/plain'

//Request URL
"Enlace para trabajar con el Master"/api/Data/GetValueByKey?key=Key


Configuración del valor de los datos por su ID.
Para generar una consulta en Swagger, debe especificar el ID de los datos y el valor a establecer.

Puede sustituir los valores requeridos (enlace para trabajar con el asistente, ID y valor) en la solicitud generada:

//Curl
  '"Enlace para trabajar con el Master"/api/Data/SetValueById?dataId=1&value=Value' \
  -H 'accept: */*' \
  -d ''

//Request URL
"Enlace para trabajar con el Master"/api/Data/SetValueById?dataId=1&value=Value


Establece el valor de los datos por su clave.
Para generar una consulta en Swagger, debe especificar una clave y un valor a establecer.
Puede sustituir los valores deseados (referencia del asistente, clave y valor) en la consulta generada:

//Curl
  '"Enlace para trabajar con el Master"/api/Data/SetValueByKey?key=Key&value=Value' \
  -H 'accept: */*' \
  -d ''

//Request URL
"Enlace para trabajar con el Master"/api/Data/SetValueByKey?key=Key&value=Value

API de colas (QueuesApi)
Trabajar con colas de datos.

Es conveniente formar solicitudes de API en Swagger ( instrucciones sobre cómo conectarse).
Hay 7 formas de interactuar con las colas:


Añadir elemento a la cola. (POST)
El Swagger genera automáticamente el enlace.
Deben especificarse los siguientes parámetros:

Puede utilizar una plantilla de consulta con los parámetros que desee:

//CURL
curl -X 'POST' \
  '"Enlace para trabajar con el Master"/api/Queues/PushElementToQueue?queueName=queueName&data=data&priority=1&postponeDate=2022-09-21T17%3A32%3A28Z&deadlineDate=2022-09-22T17%3A32%3A28Z&comment=comment&reference=reference&isReferenceUnique=false' \
  -H 'accept: text/plain' \
  -d ''

//URL
"Enlace para trabajar con el Master"/api/Queues/PushElementToQueue?queueName=queueName&data=data&priority=1&postponeDate=2022-09-21T17%3A32%3A28Z&deadlineDate=2022-09-22T17%3A32%3A28Z&comment=comment&reference=reference&isReferenceUnique=false
La solicitud de API se puede realizar en la aplicación Postman (es necesario instalar el programa en su computadora).
Para hacer esto, (1) seleccione el comando POST, inserte el enlace (URL) generado en Swagger , y (2-3) autorice por token ( Token Request API ).
Obtendremos la respuesta en forma de clave y un valor asignado.


Añadir elemento a la cola. (POST)
Esta consulta difiere de la anterior en que el valor a escribir se especifica en Body.

Puede utilizar una plantilla de consulta con los parámetros que desee:

//CURL
curl -X 'POST' \
  '"Enlace para trabajar con el Master"/api/Queues/PushElementToQueueFromBodyData?priority=1&isReferenceUnique=false' \
  -H 'accept: text/plain' \
  -H 'Content-Type: application/json' \
  -d '"data"'

//URL
"Enlace para trabajar con el Master"/api/Queues/PushElementToQueueFromBodyData?priority=1&isReferenceUnique=false
En Postman, debe especificar adicionalmente un valor en Body:

Obtenemos un Json con los campos: key es el identificador del elemento de la cola, value es el valor del elemento de la cola.

Obtener un elemento de la cola. (GET)
Puede generar una consulta en Swagger especificando los siguientes parámetros:

Puede usar una plantilla de solicitud especificando los parámetros necesarios allí:

//CURL
curl -X 'GET' \
  '"Enlace para trabajar con el Master"/api/Queues/GetElementFromQueue?queueName=%D0%9E%D1%87%D0%B5%D1%80%D0%B5%D0%B4%D1%8C1&reference=reference&priority=1&comment=comment' \
  -H 'accept: text/plain'

//URL
"Enlace para trabajar con el Master"/api/Queues/GetElementFromQueue?queueName=%D0%9E%D1%87%D0%B5%D1%80%D0%B5%D0%B4%D1%8C1&reference=reference&priority=1&comment=comment
El resultado de la consulta es un Json con los campos: key - identificador del elemento de la cola, value - valor del elemento de la cola.

Confirmar procesamiento de elementos. (POST)
Puede generar una consulta en Swagger especificando los siguientes parámetros:

Puede utilizar una plantilla de consulta con los parámetros que desee:

//CURL
curl -X 'POST' \
  '"Enlace para trabajar con el Master"/api/Queues/ConfirmQueueItemProcessFinish?id=1&isSuccess=true&errorComment=%D0%BD%D0%B5%20%D0%BE%D0%B1%D1%80%D0%B0%D0%B1%D0%BE%D1%82%D0%B0%D0%BD&errorType=1' \
  -H 'accept: */*' \
  -d ''

//URL
"Enlace para trabajar con el Master"/api/Queues/ConfirmQueueItemProcessFinish?id=1&isSuccess=true&errorComment=%D0%BD%D0%B5%20%D0%BE%D0%B1%D1%80%D0%B0%D0%B1%D0%BE%D1%82%D0%B0%D0%BD&errorType=1
Tenga en cuenta que el comentario se especifica en formato codificado.
Debe aparecer un mensaje de "éxito" en respuesta a la solicitud.

Cancelar elemento de cola. (POST)
Para generar una consulta en Swagger, debe especificar los siguientes parámetros:

Puede utilizar una plantilla de consulta con los parámetros que desee:

//CURL
curl -X 'POST' \
  '"Enlace para trabajar con el Master"/api/Queues/CancelQueueItem?id=1&comment=comment' \
  -H 'accept: */*' \
  -d ''

//URL
"Enlace para trabajar con el Master"/api/Queues/CancelQueueItem?id=1&comment=comment

Obtener el estado de un elemento. (GET)
Es necesario introducir el ID del artículo para realizar la solicitud:

//CURL
curl -X 'GET' \
  '"Enlace para trabajar con el Master"/api/Queues/GetQueueItemStatus?id=1' \
  -H 'accept: text/plain'

//URL
"Enlace para trabajar con el Master"/api/Queues/GetQueueItemStatus?id=1

Recuperar elementos de la cola por filtro. (GET)
Para generar una consulta en Swagger, debe especificar los siguientes parámetros:

Puede utilizar una plantilla de consulta con los parámetros que desee:

//CURL
curl -X 'GET' \
  '"Enlace para trabajar con el Master"/api/Queues/GetQueueItemsByFilters?queueName=%D0%9E%D1%87%D0%B5%D1%80%D0%B5%D0%B4%D1%8C1&maxItems=100&statuses=new' \
  -H 'accept: text/plain'

//URL
"Enlace para trabajar con el Master"/api/Queues/GetQueueItemsByFilters?queueName=%D0%9E%D1%87%D0%B5%D1%80%D0%B5%D0%B4%D1%8C1&maxItems=100&statuses=new
El resultado será JSON con elementos que coincidan con las condiciones del filtro.


API del programador (SchedulersApi)
Habilitar/deshabilitar el programador.

Es conveniente formar solicitudes de API en Swagger ( instrucciones sobre cómo conectarse).
Debe hacer clic en Pruébelo en la esquina superior derecha, los campos para configurar los parámetros se activarán.
Debe especificar el ID y el estado ( verdadero : habilitar, falso : deshabilitar) del programador.

Puede usar este código especificando un enlace para ejecutar el asistente (sin comillas), una ID y el estado del programador:

// CURL
curl -X 'POST' \
  '"Enlace para trabajar con el Master"/api/Schedulers/UpdateSchedulerStatus?id=1&isActive=true' \
  -H 'accept: */*' \
  -d ''

// URL
'"Enlace para trabajar con el Master"/api/Schedulers/UpdateSchedulerStatus?id=1&isActive=true

La solicitud de API se puede realizar en la aplicación Postman (es necesario instalar el programa en su computadora).
Para hacer esto, debe iniciar sesión con un token ( Token Request API ), seleccione el comando POST y pegue el enlace (URL) generado en Swagger.

API de proyecto (ProyectosApi)
La API de proyectos le permite recuperar una lista de proyectos, cargar una nueva versión de proyecto/nuevo proyecto y recuperar un archivo de proyecto sin utilizar la interfaz web del Asistente.

Es conveniente formar solicitudes de API en Swagger ( instrucciones sobre cómo conectarse).
Hay 4 formas de interactuar con los proyectos:

Obtener una lista de proyectos.
Para generar una consulta en Swagger, haga clic en Probar en la esquina superior derecha y los campos de parámetros se activarán.
No se establecen parámetros para obtener la lista de proyectos.
Puede utilizar este código con un enlace para ejecutar el Master:

// CURL
curl -X 'GET' \
  '"Enlace para trabajar con el Master"/api/Projects/GetProjectList' \
  -H 'accept: */*'

// URL
"Enlace para trabajar con el Master"/api/Projects/GetProjectList

La solicitud de API se puede realizar en la aplicación Postman (es necesario instalar el programa en su computadora).

Para hacer esto, debe (1) autorizar usando un token ( API de solicitud de token ), (2) seleccionar el comando GET y pegar el enlace (URL) generado en Swagger.

El resultado es una lista de proyectos.

El resultado será una lista de proyectos.

Descargar una nueva versión del proyecto
Los siguientes campos deben completarse en Swagger para generar la solicitud:

Puede utilizar la siguiente plantilla insertando los parámetros necesarios:

// CURL
curl -X 'POST' \
  '"Enlace para trabajar con el Master"/api/Projects/UploadProjectVersion?projectId=1&entryPoint=entryPoint&version=version&description=description&isActual=false' \
  -H 'accept: */*' \
  -d ''
// URL
"Enlace para trabajar con el Master"/api/Projects/UploadProjectVersion?projectId=1&entryPoint=entryPoint&version=version&description=description&isActual=false

Obtener archivos del proyecto
Los siguientes campos deben completarse en Swagger para generar la solicitud:

Puede utilizar la siguiente plantilla insertando los parámetros necesarios:

// CURL
curl -X 'POST' \
  '"Enlace para trabajar con el Master"/api/Projects/DownloadProject?projectId=1&version=version' \
  -H 'accept: text/plain' \
  -d ''

// URL
"Enlace para trabajar con el Master"/api/Projects/DownloadProject?projectId=1&version=version

Cargar un nuevo proyecto.
Los siguientes campos deben completarse en Swagger para generar la solicitud:

Puede utilizar la siguiente plantilla insertando los parámetros necesarios:

// CURL
curl -X 'POST' \
  '"Enlace para trabajar con el Master"/api/Projects/UploadProject?entryPoint=entryPoint&name=name&description=description' \
  -H 'accept: */*' \
  -d ''

// URL
"Enlace para trabajar con el Master"/api/Projects/UploadProject?entryPoint=entryPoint&name=name&description=description