Niucore

Referencia

Perfil

El usuario en cuyo nombre actúa la credencial.

Ver el perfil

GETapi.niucore.com/api/v1/me

Scope: profile:read

El «¿quién soy?» de la API: confirma que el token funciona y dice con qué permisos y qué scopes efectivos va a operar la credencial.

Sugerencia

Es el primer request que conviene hacer al integrar. Si scopes trae menos de lo que pediste, el rol del usuario recortó el alcance — y ahí está la explicación de cualquier 403 posterior.

Devuelve

idinteger

Id del usuario titular.

namestring

Nombre.

emailstring

Email.

company_idinteger

Empresa.

rolestring

Rol en la plataforma.

permissionsstring[]

Permisos efectivos del usuario en este momento.

scopesstring[]

Scopes efectivos = los del token ∩ los que sus permisos habilitan.

tokenobject

La credencial en uso: id, client_id y type (user o admin).

curl -sS -X GET 'https://api.niucore.com/api/v1/me' \
  -H "Authorization: Bearer $NIUCORE_ACCESS_TOKEN"
Respuesta
{
  "status": "success",
  "message": "Operación exitosa",
  "message_code": "api_v1_ok",
  "data": {
    "id": 2099,
    "name": "Integraciones ACME",
    "email": "integraciones@acme.com",
    "phone": "+54 11 5555 0000",
    "job_title": "Cuenta de servicio",
    "timezone": "America/Argentina/Buenos_Aires",
    "company_id": 2149,
    "role": "admin",
    "permissions": [
      "sidebar.chat",
      "workspaces.read.all",
      "skills.read.all"
    ],
    "scopes": [
      "chat:read",
      "chat:write",
      "libraries:read",
      "profile:read"
    ],
    "token": {
      "id": 412,
      "client_id": "nc_7f3c1a9b8e2d4056",
      "type": "user"
    }
  },
  "meta": {
    "request_id": "9f1c0a3e-7b2d-4f18-9a55-2c6e0d1b4a77"
  }
}

Editar el perfil

PATCHapi.niucore.com/api/v1/me

Scope: profile:write

Actualiza datos del usuario titular. Solo los campos listados: mandar role o email devuelve 422, no se ignora en silencio.

Cuerpo

namestring

Hasta 100 caracteres.

phonestring

Hasta 32 caracteres.

documentstring

Documento.

document_typestring

Tipo de documento. Texto libre de hasta 16 caracteres: no hay catálogo ni lista cerrada, así que guardá el valor que use tu organización (DNI, CUIT, RUT, passport…).

country_idinteger

País. Los ids válidos salen de `GET /catalog/countries`.

job_titlestring

Puesto.

timezonestring

Zona horaria IANA.

Errores

  • 422api_v1_validation_errorSe envió un campo que la API no acepta, o uno fuera de rango.
curl -sS -X PATCH 'https://api.niucore.com/api/v1/me' \
  -H "Authorization: Bearer $NIUCORE_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "job_title": "Cuenta de servicio",
    "timezone": "America/Argentina/Buenos_Aires"
  }'
Respuesta
{
  "status": "success",
  "message": "Operación exitosa",
  "message_code": "api_v1_ok",
  "data": {
    "id": 2099,
    "name": "Integraciones ACME",
    "email": "integraciones@acme.com",
    "phone": "+54 11 5555 0000",
    "job_title": "Cuenta de servicio",
    "timezone": "America/Argentina/Buenos_Aires",
    "company_id": 2149,
    "role": "admin",
    "permissions": [
      "sidebar.chat",
      "workspaces.read.all",
      "skills.read.all"
    ],
    "scopes": [
      "chat:read",
      "chat:write",
      "libraries:read",
      "profile:read"
    ],
    "token": {
      "id": 412,
      "client_id": "nc_7f3c1a9b8e2d4056",
      "type": "user"
    }
  },
  "meta": {
    "request_id": "9f1c0a3e-7b2d-4f18-9a55-2c6e0d1b4a77"
  }
}