Saltar al contenido principal
Docs
Ir al Studio
Roberty Studio
RPAAPI

Crear Cliente de API

Crear Cliente de API

Configura un cliente de API reutilizable: certificado de cliente (mTLS), autoridad certificadora (CA), URL base, encabezados predeterminados y autenticación OAuth2. Las acciones de Solicitud de API que seleccionen este cliente pasan a usar esta configuración, sin necesidad de repetirla en cada solicitud.


Opciones​

Certificado de cliente (mTLS)​

Úsalo cuando la API exige que el cliente se identifique con un certificado digital (TLS mutuo), común en integraciones bancarias, gubernamentales y entre empresas.

Ruta del certificado (.pfx)​

Indica la ruta del archivo del certificado en formato PKCS#12 (.pfx o .p12), que reúne el certificado y la clave privada. El archivo debe existir en el dispositivo que ejecuta el robot.

Contraseña del certificado​

Indica la contraseña que protege el archivo del certificado.

Ruta de la CA (opcional)​

Indica la ruta del certificado de la autoridad certificadora (CA) del servidor. Solo es necesario cuando el servidor usa una autoridad certificadora privada o autofirmada.

Configuraciones predeterminadas​

URL base​

Indica el inicio común de las direcciones de la API, por ejemplo https://api.socio.com/v1. Las acciones de Solicitud de API que usen este cliente pueden enviar solo la ruta (ej.: /pedidos).

Encabezados predeterminados​

Indica, en código, los encabezados enviados en todas las solicitudes que usen este cliente. El código debe devolver los encabezados, como objeto o new Headers(...):

js
return {
  "Accept": "application/json",
}

Autenticación (OAuth2 client credentials)​

Complétala cuando la API usa el flujo OAuth2 client credentials. El cliente obtiene el token de acceso por sí solo y lo envía en el encabezado Authorization de cada solicitud, así que no es necesario armar ese encabezado a mano.

URL del token​

Indica la dirección que emite el token de acceso. La autenticación solo se configura cuando este campo está completo.

Client ID​

Indica el identificador del cliente proporcionado por el proveedor de la API.

Client secret​

Indica el secreto del cliente proporcionado por el proveedor de la API.

Scope (opcional)​

Indica los alcances solicitados, cuando el proveedor los exija.

Audience (opcional)​

Indica la audiencia (audience) del token, cuando el proveedor la exija.

Enviar credenciales en​

Selecciona cómo se envían el Client ID y el Client secret al pedir el token:

  • Encabezado Authorization (Basic) — predeterminado, el más común.
  • Cuerpo de la solicitud — para proveedores que esperan client_id y client_secret en el cuerpo.

Retornos​

Esta acción no tiene campos de salida para seleccionar. El cliente creado se usa en el campo Cliente de API (opcional) de la acción Solicitud de API.

Ejemplo de uso​

  1. Agrega la acción Crear Cliente de API al inicio del flujo, con el certificado, la URL base https://api.socio.com/v1 y los datos de autenticación.
  2. Agrega una Solicitud de API después de ella, selecciona el cliente en el campo Cliente de API (opcional) e indica solo la ruta /pedidos en la URL.
  3. Repite el paso 2 para las demás llamadas a la misma API — todas reutilizan el certificado, los encabezados y el token.

Reglas y Condiciones​

  • La acción debe estar en el mismo flujo que las solicitudes que la usan, y antes de ellas.
  • Los archivos del certificado y de la CA se leen en el dispositivo que ejecuta el robot.
  • El certificado se valida al crear el cliente: una ruta inexistente, un archivo dañado o una contraseña incorrecta hacen fallar esta acción, y no la primera solicitud.
  • Con la URL del token completa, el cliente se autentica ya en la creación. Si el proveedor rechaza las credenciales o la respuesta no trae access_token, esta acción falla.
  • El token se renueva automáticamente poco antes de expirar. Si la API responde 401, el cliente se autentica de nuevo y repite la solicitud una única vez.
  • Cuando el mismo encabezado aparece en más de un lugar, vale el más específico: encabezados predeterminados del cliente < token de autenticación < encabezados de la propia solicitud. Los nombres de encabezado no distinguen mayúsculas de minúsculas.
  • La configuración del cliente, incluida la contraseña del certificado y el Client secret, queda disponible en actions["id-de-la-accion"] durante la ejecución. Evita registrar este valor en logs y guarda la contraseña y el Client secret en parámetros de tipo contraseña, en lugar de escribirlos en la acción.