Conexión REST genérica
La conexión REST genérica conecta PlaidCloud con cualquier servicio HTTP/REST que no tenga un conector específico. Admite los patrones de autenticación habituales (None, Basic, API Key, token de portador, OAuth 2.0), encabezados de solicitud predeterminados, un control detallado de redirecciones y del transporte, y un probador de solicitudes integrado en el formulario.
Los convertidores, como el importador de Savant, pueden crear conexiones REST que contienen valores secretos cifrados. Los pasos que convierten usan esos valores en el momento de la ejecución.
Configuración
Sección titulada «Configuración»El formulario tiene cuatro pestañas.
Detalles de la conexión
Sección titulada «Detalles de la conexión»| Campo | Tipo | Descripción |
|---|---|---|
| Nombre de la conexión | Texto | Nombre para mostrar de esta conexión. |
| Memo | Texto (varias líneas) | Notas opcionales sobre la conexión. |
| Host o dirección IP | Texto | Host base al que se dirigen las solicitudes. |
| Activa (permitir acceso) | Interruptor | Indica si la conexión está habilitada. Deshabilítela para pausarla sin eliminarla. |
| Tipo de autenticación | Selección | None, Basic, API Key, Bearer Token, OAuth 2.0, Azure Cosmos DB (Master Key) o Azure Cosmos DB (Microsoft Entra ID). Al seleccionar un tipo se habilita el grupo correspondiente en la pestaña Autenticación. |
| Modelo de seguridad | Selección | Quién puede usar la conexión: Privado, Miembros específicos, Grupos de seguridad específicos o Todos los miembros del espacio de trabajo. |
Configuración de la conexión
Sección titulada «Configuración de la conexión»| Configuración | Valor predeterminado | Descripción |
|---|---|---|
| Habilitar la verificación de certificados SSL | Desactivado | Verifica los certificados SSL al enviar una solicitud. Si la verificación falla, se cancela la solicitud. |
| Seguir redirecciones automáticamente | Activado | Sigue las respuestas HTTP 3xx como redirecciones. |
| Seguir el método HTTP original | Desactivado | Redirige con el método HTTP original en lugar de redirigir con GET, que es lo predeterminado. |
| Seguir el encabezado de autorización | Desactivado | Conserva el encabezado de autorización cuando se produce una redirección. |
| Quitar el encabezado referer en la redirección | Desactivado | Quita el encabezado referer cuando se produce una redirección. |
| Habilitar analizador HTTP estricto | Desactivado | Rechaza las respuestas con encabezados HTTP no válidos. |
| Codificar la URL automáticamente | Activado | Codifica la ruta de la URL, los parámetros de consulta y los campos de autenticación. |
| Deshabilitar el almacén de cookies | Desactivado | No almacena las cookies de esta solicitud en el almacén de cookies ni envía como encabezados las cookies almacenadas. |
| Usar el conjunto de cifrado del servidor durante el protocolo de enlace | Desactivado | Usa el orden de conjuntos de cifrado del servidor en lugar del del cliente durante el protocolo de enlace. |
| Número máximo de redirecciones | 10 | Límite del número de redirecciones que se siguen. |
Definición de la API
Sección titulada «Definición de la API»Opcional. Adjunte a la conexión la definición OpenAPI 3.x o Swagger 2.0 de la API, y cualquier paso Solicitud REST que la use podrá enumerar los puntos de conexión de la API, con sus métodos, parámetros y cuerpos de solicitud ya completados, sin volver a indicar la definición en cada paso.
| Campo | Tipo | Descripción |
|---|---|---|
| Definición | Selección | None, OpenAPI / Swagger URL o OpenAPI / Swagger file. |
| URL de la definición | Texto | Dirección en la que se publica la especificación, por ejemplo https://api.example.com/openapi.json. Se muestra al elegir URL. |
| Archivo de definición | Archivo | Una especificación .json o .yaml almacenada en Documentos. Se muestra al elegir archivo. |
En un paso Solicitud REST, elija esta conexión, establezca Origen de puntos de conexión en Desde la definición de API de la conexión y luego elija Cargar catálogo.
Autenticación
Sección titulada «Autenticación»Solo se muestra el grupo que corresponde al Authentication Type seleccionado. Con None, la pestaña está deshabilitada.
Básica
| Campo | Tipo | Descripción |
|---|---|---|
| Usuario | Texto | Nombre de usuario de la autenticación básica. |
| Contraseña | Contraseña | Contraseña de la autenticación básica (de solo escritura). |
Clave de API
| Campo | Tipo | Descripción |
|---|---|---|
| Clave | Texto | Nombre del campo de la clave de API. |
| Valor | Texto | Valor de la clave de API. |
Token de portador
| Campo | Tipo | Descripción |
|---|---|---|
| Token | Contraseña | Token de portador (de solo escritura). |
OAuth 2.0
| Campo | Tipo | Descripción |
|---|---|---|
| Agregar datos de autenticación a | Selección | Envía los datos de autenticación en los Request Headers o en la Request URL. |
| Prefijo del encabezado | Texto | Prefijo del valor del encabezado de autorización (Bearer de forma predeterminada). |
| URL de autenticación | Texto | Punto de conexión de autorización. |
| URL del token de acceso | Texto | Punto de conexión del token. |
| ID de cliente | Texto | Identificador del cliente de OAuth. |
| Secreto de cliente | Texto | Secreto del cliente de OAuth. |
| URL del token de actualización | Texto | Punto de conexión que se usa para actualizar el token. |
| Token de actualización inicial | Texto | Token de actualización inicial para el primer intercambio. |
| Parámetros adicionales de la solicitud de token | Tabla | Parámetros adicionales del cuerpo que se envían en las solicitudes de token (Habilitado, Nombre, Valor, Descripción). |
| Encabezados adicionales de la solicitud de token | Tabla | Encabezados adicionales que se envían en las solicitudes de token (Habilitado, Nombre, Valor, Descripción). |
Azure Cosmos DB (Clave maestra)
| Campo | Tipo | Descripción |
|---|---|---|
| Clave maestra | Contraseña | La clave maestra de la cuenta de Cosmos DB (de solo escritura). Cada solicitud se firma con ella, como exige la API REST de Cosmos DB. |
Azure Cosmos DB (Microsoft Entra ID)
| Campo | Tipo | Descripción |
|---|---|---|
| URL del token de acceso | Texto | El punto de conexión del token de su inquilino, como https://login.microsoftonline.com/<tenant>/oauth2/v2.0/token. |
| ID de cliente | Texto | El ID de cliente de la aplicación de Entra. |
| Secreto de cliente | Contraseña | El secreto de cliente de la aplicación de Entra (de solo escritura). |
Use una conexión de Cosmos DB con el paso Solicitud REST para consultar los documentos de un contenedor y escribirlos. Establezca la URL base de la conexión en el punto de conexión de la cuenta de Cosmos DB.
Encabezados predeterminados
Sección titulada «Encabezados predeterminados»Una tabla de encabezados que se envían en cada solicitud realizada a través de esta conexión. Cada fila tiene Enabled, Header Name, Value y Description. Use los botones de fila para agregar, insertar y eliminar encabezados. Estos encabezados se envían con cada solicitud que realiza la conexión, incluidas cada página de una lectura paginada y cada solicitud de una distribución por filas; un encabezado definido en un paso individual tiene prioridad sobre uno del mismo nombre definido aquí.
Pruebas
Sección titulada «Pruebas»Envíe una solicitud ad hoc a través de la conexión guardada para confirmar que funciona.
| Campo | Tipo | Descripción |
|---|---|---|
| Punto de conexión de prueba | Texto | URL completa a la que se llama (por ejemplo, https://example.com/rest/test/validate). |
| Método | Selección | GET, PUT, POST, DELETE, HEAD u OPTIONS. |
| Carga útil | Código | Cuerpo de la solicitud. Admite tokens de plantilla al estilo de Django/Jinja. |
| Enviar solicitud de prueba | Botón | Envía la solicitud y muestra la respuesta (o el error). |
Temas relacionados
Sección titulada «Temas relacionados»- Conectores REST — conectores específicos para Salesforce, NetSuite, Workday y otros servicios REST.
- Importar datos de Samsara — una receta para copiar y pegar para una API que usa paginación por cursor.
- Crear y administrar una conexión
- Paso de flujo de trabajo Solicitud REST