COLABORADOR

Endpoints

Buscar colaboradores

GET /employee

Descripción: Devuelve todos los colaboradores registrados, pudiendo filtrar por nombre, correo electrónico, id, unidad, entre otros.

GET /public/employee?limit=100&external_store_id=EX123 HTTP/1.1
Host: api.solucx.com.br
x-solucx-api-key: TU_API_KEY
Accept: */*

Respuestas:

• 200 OK: Devuelve la lista de colaboradores.

Criar colaborador

POST /employee

Descripción: Crea un nuevo colaborador.

POST /public/employee HTTP/1.1
Host: api.solucx.com.br
x-solucx-api-key: TU_API_KEY
Content-Type: application/json
Accept: */*

{
  "employee_id": "EMP123",
  "name": "Juan",
  "email": "[email protected]",
  "store_id": "EX123"
}

Respostas:

• 200 OK: Colaborador criado com sucesso.
• 400 Bad Request: Parámetros inválidos.

Buscar colaborador por id

GET /employee/{id}

Descripción: Devuelve un colaborador por id.

GET /public/employee/{id} HTTP/1.1
Host: api.solucx.com.br
x-solucx-api-key: TU_API_KEY
Accept: */*

Respuestas:

• 200 OK: Devuelve el colaborador.
• 404 Not Found: Colaborador no encontrado.

Editar colaborador

PUT /employee/{id}

Descripción: Edita un colaborador existente.

PUT /public/employee/{id} HTTP/1.1
Host: api.solucx.com.br
x-solucx-api-key: TU_API_KEY
Content-Type: application/json
Accept: */*

{
  "name": "Nuevo Nombre",
  "email": "[email protected]"
}

Respostas:

• 200 OK: Colaborador editado com sucesso.
• 422 Unprocessable Entity: Parámetros inválidos.

Inativar colaborador

DELETE /employee/{id}

Descripción: Inactiva un colaborador existente.

DELETE /public/employee/{id} HTTP/1.1
Host: api.solucx.com.br
x-solucx-api-key: TU_API_KEY
Accept: */*

Respostas:

• 200 OK: Colaborador inativado com sucesso.
• 422 Unprocessable Entity: Colaborador no encontrado.

Listado de unidades vinculadas al colaborador

GET /employee/{id}/stores

Descrição: Descripción: Utilizando el ID generado en la creación del colaborador (ID interno), es posible saber qué unidades están vinculadas al colaborador.

GET /public/employee/{id}/stores HTTP/1.1
Host: api.solucx.com.br
x-solucx-api-key: YOUR_API_KEY
Accept: */*

Respostas:

• 200 OK: Devuelve la lista de colaboradores.
• 404 Not Found: Colaborador no encontrado.

Editar Relación de Unidades con el Colaborador

PUT /employee/{ID}/stores

Descrição: Debe utilizarse el ID generado al crear el colaborador. Es necesario pasar únicamente el ID interno de las unidades que se desean vincular con el colaborador. Es necesario tener acceso a las unidades que se desean modificar (agregar o quitar). El resultado de la solicitud es la nueva relación de unidades del colaborador.

PUT /public/employee/{id}/stores HTTP/1.1
Host: api.solucx.com.br
x-solucx-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 19

[
  123,
  1213,
  222,
  1423
]

Respostas:

• 200 OK: Devuelve la lista de colaboradores.
• 401 Not Authorized: No autorizado.
• 404 Not Found: Colaborador no encontrado.

Listado de grupos vinculados al colaborador

GET /employee/{id}/groups

Descrição: Utilizando el ID generado en la creación del colaborador (ID interno), es posible saber qué grupos están vinculados al colaborador.

GET /public/employee/{id}/groups HTTP/1.1
Host: api.solucx.com.br
x-solucx-api-key: YOUR_API_KEY
Accept: */*

Respostas:

• 200 OK: Devuelve la lista de colaboradores.
• 404 Not Found: Colaborador no encontrado.

Editar Relación de Grupos con el Colaborador

PUT /employee/{id}/groups

Descrição: Debe utilizarse el ID generado al crear el colaborador. Es necesario pasar únicamente el ID interno de los grupos que se desean vincular con el colaborador. Es necesario tener acceso a los grupos que se desean modificar (agregar o quitar). El resultado de la solicitud es la nueva relación de grupos del colaborador.

PUT /public/employee/{id}/groups HTTP/1.1
Host: api.solucx.com.br
x-solucx-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 19

[
  123,
  1213,
  222,
  1423
]

Respostas:

• 200 OK: Devuelve la lista de colaboradores.
• 401 Not Authorized: No autorizado.
• 404 Not Found: Colaborador no encontrado.