getMe()

Consulta la identidad de la integración, la cuenta propietaria y los permisos de la API key.

Permiso: API key válida, sin scope adicional.

getMe(
  options?: RequestOptions
): Promise<PublicMe>

Referencia HTTP: GET /me

• Requiere una API key válida y acceso a la API; no exige un scope adicional. No comprueba que el CSD ni los datos fiscales estén listos para timbrar.

Parámetros

Argumento	Tipo	Obligatorio	Uso
options	RequestOptions	No	signal e idempotencyKey; consulta las opciones por solicitud.

Opciones por solicitud: signal e idempotencyKey.

Ejemplo

Usa el cliente factucat de Instala y conecta. Los IDs y datos fiscales de este ejemplo son ilustrativos: reemplázalos por los registros de tu cuenta y ambiente.

const resultado = await factucat.getMe()
console.log(resultado)

Respuesta

Resuelve una Promise<PublicMe>. El valor recibido es directamente data, sin el envoltorio HTTP ni sus metadatos.

Campo	Tipo	Obligatorio	Descripción
actorType	string	Sí	Tipo de actor autenticado por la llave.Mínimo 1 carácter
actorId	string	Sí	ID de la integración autenticada.Mínimo 1 carácter
ownerUserId	string	Sí	ID del usuario propietario de la llave.Mínimo 1 carácter
ownerUserName	string	No	Nombre del propietario, cuando está disponible.Mínimo 1 carácter
ownerUserEmail	string	No	Correo del propietario, cuando está disponible.Formato: email
scopes	Array<string>	Sí	Permisos concedidos a la API key.

Ejemplo de respuesta

{
  "actorType": "integration",
  "actorId": "integracion_ejemplo",
  "ownerUserId": "usuario_ejemplo",
  "ownerUserName": "Cuenta de ejemplo",
  "scopes": [
    "customer:read",
    "invoice:read"
  ]
}

Las fechas se entregan como cadenas ISO 8601. Un campo opcional puede estar ausente. Tipos, paginación y archivos.

La promesa se rechaza si la API devuelve un error, falla la conexión o los datos no cumplen el contrato. Cómo manejar los errores.