Referencia

Usuarios y catálogos

Los valores de referencia que hacen falta para escribir el resto del contrato: ids de usuario y de país.

Países

GETapi.niucore.com/api/v1/catalog/countries

Scope: profile:read

Los países activos, para el selector de country_id del perfil.

Nota

No se pagina: son unas doscientas filas que casi no cambian. meta trae solo request_id.

Devuelve

idinteger

El valor de country_id.

codestring

Código ISO.

namestring

Nombre del país.

currencystring

Moneda del país.

curl -sS -X GET 'https://api.niucore.com/api/v1/catalog/countries' \
  -H "Authorization: Bearer $NIUCORE_ACCESS_TOKEN"
Respuesta
{
  "status": "success",
  "message": "Operación exitosa",
  "message_code": "api_v1_ok",
  "data": [
    {
      "id": 11,
      "code": "AR",
      "name": "Argentina",
      "currency": "ARS"
    },
    {
      "id": 32,
      "code": "CL",
      "name": "Chile",
      "currency": "CLP"
    }
  ],
  "meta": {
    "request_id": "9f1c0a3e-7b2d-4f18-9a55-2c6e0d1b4a77"
  }
}

Usuarios de la empresa

GETapi.niucore.com/api/v1/users

Scope: users:read

Los usuarios de la empresa, para armar shared_user_ids al compartir una habilidad.

Solo lectura, y deliberadamente pobre

Devuelve lo justo para poblar un selector. No devuelve role, phone, document ni datos de licencia: eso es administración de personas y se hace en la aplicación, no con una credencial de máquina. Tampoco se crean, editan ni borran usuarios por la API.

El alcance es el mismo de la aplicación: con users.read.all se ve toda la empresa; con solo users.read.area, únicamente quienes comparten alguna área con el usuario titular de la credencial.

Consulta

pageintegerpor defecto 1

Página, empezando en 1.

sizeintegerpor defecto 50

Elementos por página. Máximo 200.

searchstring

Filtra por nombre o correo, sin distinguir mayúsculas.

Devuelve

idinteger

El valor para shared_user_ids.

namestring

Nombre.

emailstring

Correo.

is_activeboolean

Si puede entrar.

area_idsinteger[]

Áreas a las que pertenece.

curl -sS -X GET 'https://api.niucore.com/api/v1/users?page=1&size=50' \
  -H "Authorization: Bearer $NIUCORE_ACCESS_TOKEN"
Respuesta
{
  "status": "success",
  "message": "Operación exitosa",
  "message_code": "api_v1_ok",
  "data": [
    {
      "id": 2099,
      "name": "Ada Lovelace",
      "email": "ada@acme.com",
      "is_active": true,
      "area_ids": [
        7,
        9
      ]
    },
    {
      "id": 2104,
      "name": "Grace Hopper",
      "email": "grace@acme.com",
      "is_active": true,
      "area_ids": [
        7
      ]
    }
  ],
  "meta": {
    "request_id": "9f1c0a3e-7b2d-4f18-9a55-2c6e0d1b4a77",
    "page": 1,
    "size": 50,
    "total": 2
  }
}