Herramienta API de Server
Utiliza la herramienta API de servidor para interactuar con la API de servidor (v1, v2 y v3) sin necesidad de escribir un flujo de trabajo complejo. Para obtener información sobre el acceso a la API de Server, su autenticación, sus puntos de conexión, sus parámetros y sus versiones, ve a la página Descripción general de la API de Server.
Sugerencia
Esta herramienta no se instala automáticamente con Alteryx Designer. Para utilizar esta herramienta, descárgala de Alteryx Marketplace.
La herramienta API de Server es compatible con la versión 2021.4 y posterior de Designer y Server. Ten en cuenta que ciertas capacidades de la herramienta pueden ser limitadas en función de tu versión de Server.
Compatible tanto con el Alteryx Multi-threaded Processing (AMP) de Alteryx como con el Engine original.
La herramienta API de Server no es compatible actualmente con el modo Solo DCM del Administrador de conexiones de datos.
La herramienta API de Server requiere que tenga estos paquetes instalados en la máquina:
oauthlibrequests_oauthlib
Si no tienes estos paquetes instalados…
Agrega la herramienta API de Server al lienzo de tu flujo de trabajo y ejecuta el flujo de trabajo. La herramienta genera un error para alertarte sobre cualquier paquete que falte.
Ve a la ventana Resultados del flujo de trabajo y selecciona la pestaña Todos (o Archivos para limitar la lista de elementos).
Localiza y selecciona el mensaje que dice: “Ejecutar este flujo de trabajo vinculado como administrador para instalar los paquetes faltantes”. Esto abre un nuevo flujo de trabajo con una herramienta Python que está preconfigurada para instalar los paquetes necesarios. Ejecuta el flujo de trabajo para realizar la instalación. Ten en cuenta que debes ejecutar este flujo de trabajo de instalación como administrador.
Alternativamente, puedes replicar lo anterior e instalar los paquetes a través de la herramienta Python. Ve a Instalación de paquetes adicionales para aprender cómo instalar paquetes.
La herramienta API de Server tiene seis anclas:
Anclas de entrada (ambas son opcionales):
Ancla de entrada A (autorización): si eliges utilizar valores de campos en la configuración de la herramienta, usa esta ancla para proporcionar la información de autorización. Selecciona el campo que contiene la URL base de la API y otro campo que contiene la información de autorización (normalmente, este es el campo Autorización de la salida A de una herramienta API de Server ascendente). Ten en cuenta que la información de autorización es una combinación del prefijo portador y access_token que genera oAuth2.0 cuando se autentica inicialmente. Consulta Configuración y autorización de las API de Server para obtener más información.
Ancla de entrada D (datos): si eliges utilizar valores de campos en la configuración de la herramienta, usa esta ancla a fin de proporcionar parámetros para tu punto de conexión. Ten en cuenta que ciertos puntos de conexión tienen parámetros obligatorios.
Anclas de salida:
Ancla de salida A (authToken): esta ancla genera tu información de autenticación para que esté disponible en caso de que desees realizar varias llamadas. Conecta esta ancla de salida al ancla de entrada A de otra herramienta API de Server para volver a autenticar sin problemas otra llamada de API descendente.
Ancla de salida S (correcto): esta ancla genera cualquier llamada de API con un código de respuesta de 200. Analizamos las respuestas de la API a un nivel inferior* y generamos los campos aquí. Si no podemos analizar una respuesta, el campo de salida Extraído contiene un mensaje con el motivo, y proporcionamos los datos sin procesar en los campos de salida DownloadData y BinaryData.
Ancla de salida F (falla): esta ancla genera cualquier llamada de API que no reciba un código de respuesta de 200.
Ancla de salida L (archivos de registros): esta ancla genera la información de registro que resulta de tu llamada a la API.
Esta respuesta se simplifica a efectos de este ejemplo. El ejemplo de JSON sin procesar muestra una respuesta de JSON típica, seguida de un ejemplo de la misma respuesta a través de la herramienta API de Server.
[
{
"id": "12345",
"dateCreated": "2023-05-02T16:50:05.829Z",
"runCount": 0,
"versions": [
{
"versionId": "67890",
"versionNumber": 1,
"dateCreated": "2023-05-02T16:50:05.829Z",
"details": {
"isAmp": false,
"fileName": "test.yxmd"
}
}
]
},
{
"id": "54321",
"dateCreated": "2023-05-03T10:50:48.681Z",
"runCount": 0,
"versions": [
{
"versionId": "09876",
"versionNumber": 1,
"dateCreated": "2023-05-03T10:50:48.681Z",
"details": {
"isAmp": false,
"fileName": "test2.yxmd"
}
}
]
}
]
La misma respuesta se formatea de la siguiente manera a través de la herramienta API de Server. Ten en cuenta que el elemento de versiones se consolida en una columna/campo en la respuesta de la herramienta API de Server.
id | dateCreated | runCount | versions |
|---|---|---|---|
12345 | 2023-05-02T16:50:05.829Z | 0 | [{'versionId': '67890', 'versionNumber': 1, 'dateCreated': '2023-05-02T16:50:05.829Z', 'details': {'isAmp': False, 'fileName': 'test.yxmd'}}] |
54321 | 2023-05-03T10:50:48.681Z | 0 | [{'versionId': '09876', 'versionNumber': 1, 'dateCreated': '2023-05-03T10:50:48.681Z', 'details': {'isAmp': False, 'fileName': 'test2.yxmd'}}] |
Utiliza la ventana Configuración de herramientas a fin de configurar los campos necesarios para ejecutar tu llamada a la API.
Usa la sección Autenticación para proporcionar la información de autenticación requerida. Para obtener más información, ve a Claves de la API y Acceso a API, así como Configuración y autorización de la API de Server.
Utiliza los valores de los campos: desactivada por defecto. Activa esta opción para especificar un campo entrante que almacene la información de la URL base y el token de autorización (clave de acceso de la API y secreto de acceso de la API). Selecciona los campos a través de los menús desplegables Selecciona el campo de la URL base y Selecciona un campo de autorización. Si utilizas esta opción, solo usaremos el primer registro que proporciones como URL base y token de autenticación.
También puedes proporcionar tu información de autenticación directamente a través de la ventana Configuración de herramientas. Ten en cuenta que estos campos están ocultos si activas la opción Utiliza los valores de los campos.
URL base: proporciona la URL base para tu API de Server. Puedes configurar esto a través de Configuración de la interfaz de usuario de Server.
Clave de la API: introduce tu clave de la API.
Secreto de la API: ingresa tu secreto de la API.
Utiliza la sección Configuración de la API para seleccionar el método, elegir un punto de conexión y proporcionar parámetros para tu llamada a la API.
Elige el método: utiliza este menú desplegable para seleccionar el método de la API. Elige entre…
GET: el método GET te permite leer o ver un recurso. Por ejemplo, el método GET en un punto de conexión de usuarios te permite leer o ver una lista de usuarios.
POST: el método POST te permite crear un recurso. Por ejemplo, el método POST en un punto de conexión de usuarios te permite crear un nuevo usuario.
PUT: el método PUT te permite actualizar un recurso. Específicamente, el método PUT reemplaza el recurso existente. Por ejemplo, el método PUT en un punto de conexión de usuarios te permite actualizar reemplazando los detalles de usuario existentes con la información de usuario que proporciones.
DELETE: el método DELETE te permite eliminar un recurso. Por ejemplo, el método DELETE en un punto de conexión de usuarios te permite eliminar un usuario existente. Al seleccionar el método DELETE, aparece el interruptor Confirma el método DELETE. Debes habilitar este interruptor para ejecutar con éxito una eliminación.
Punto de conexión: utiliza este menú desplegable para seleccionar el punto de conexión. Las opciones varían dependiendo del método que selecciones. Para obtener más información sobre los puntos de conexión y parámetros de la API de Server, ve a Puntos de conexión y parámetros de la API, Acceder a la API V3 de Server y Objetos de la API V3 de Server.
Utiliza los campos entrantes para los parámetros*: desactivada por defecto. Activa esta opción para especificar los campos entrantes que se usarán como parámetros. A continuación, usa los menús desplegables disponibles para especificar el campo que contiene la información de parámetros.
Ingresar los valores de los parámetros*: si decides no utilizar los campos entrantes para tus parámetros, puedes introducir los parámetros directamente a través de los campos proporcionados.
Parámetros del punto de conexión
Ten en cuenta que los parámetros disponibles dependen del punto de conexión. Además, algunos puntos de conexión tienen parámetros obligatorios, mientras que otros no. Para obtener más información sobre los puntos de conexión y parámetros de la API de Server, ve a Puntos de conexión y parámetros de la API, Acceder a la API V3 de Server y Objetos de la API V3 de Server.
Carga útil: si eliges introducir la carga útil de forma manual, puedes introducirla aquí directamente en formato JSON. Alternativamente, usa el interruptor Utiliza los campos entrantes para los parámetros de arriba para especificar el campo entrante que contiene la carga útil.
Ejemplo de esquema: si corresponde, el ejemplo de esquema se completa con una estructura correcta para la carga útil de la API. Puedes seleccionar el botón Utiliza el esquema en la carga para copiar el texto genérico en la pestaña Carga y modificarlo.