COLABORADOR

Endpoints

Buscar colaboradores

GET /employee

Descrição: Retorna todos os colaboradores cadastrados, podendo filtrar por nome, email, id, unidade, entre outros.

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

Respostas:

• 200 OK: Retorna lista de colaboradores.

Criar colaborador

POST /employee

Descrição: Cria um novo colaborador.

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

{
  "employee_id": "EMP123",
  "name": "João",
  "email": "[email protected]",
  "store_id": "EX123"
}

collapsible{title="Parâmetros de Body"} ::card ::field-group ::field{name="employee_id" type="string"} ID externo do colaborador. :: ::field{name="name" type="string" required=true} Nome do colaborador. :: ::field{name="email" type="string"} Email do colaborador. :: ::field{name="store_id" type="string"} ID externo da unidade. :: :: :: ::

Respostas:

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

Buscar colaborador por id

GET /employee/{id}

Descrição: Retorna um colaborador pelo id.

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

collapsible{title="Parâmetros de Path"} ::card ::field-group ::field{name="id" type="string" required=true} ID do colaborador. :: :: :: ::

Respostas:

• 200 OK: Retorna o colaborador.
• 404 Not Found: Colaborador não encontrado.

Editar colaborador

PUT /employee/{id}

Descrição: Edita um colaborador existente.

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

{
  "name": "Novo Nome",
  "email": "[email protected]"
}

Respostas:

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

Inativar colaborador

DELETE /employee/{id}

Descrição: Inativa um colaborador existente.

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

Respostas:

• 200 OK: Colaborador inativado com sucesso.
• 422 Unprocessable Entity: Colaborador não encontrado.

Listagem de unidades vinculadas ao colaborador

GET /employee/{id}/stores

Descrição: Utilizando o id gerado na criação do colaborador (id interno) é possivel saber quais unidades estam vinculadas ao 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: Retorna lista de colaboradores.
• 404 Not Found: Colaborador não encontrado.

Editar o Relacionamento das Unidades com o Colaborador

PUT /employee/{ID}/stores

Descrição: Deve ser utilizado o id gerado ao realizar a criação do colaborador. Necessário passar apenas o ID Interno das Unidades a qual quer atrelar com o Colaborador. é necessario ter acesso as unidades a qual deseja modificar do colaborador (adicionar ou remover). O Resultado da requisição é a nova Relação de unidades do 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: Retorna lista de colaboradores.
• 401 Not Authorized: Não autorizado.
• 404 Not Found: Colaborador não encontrado.

Listagem de grupos vinculadas ao colaborador

GET /employee/{id}/groups

Descrição: Utilizando o id gerado na criação do colaborador (id interno) é possivel saber quais grupos estam vinculadas ao 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: Retorna lista de colaboradores.
• 404 Not Found: Colaborador não encontrado.

Editar o Relacionamento dos Grupos com o Colaborador

PUT /employee/{id}/groups

Descrição: Deve ser utilizado o id gerado ao realizar a criação do colaborador. Necessário passar apenas o ID Interno dos Grupos a qual quer atrelar com o Colaborador. é necessario ter acesso aos Grupos a qual deseja modificar do colaborador (adicionar ou remover). O Resultado da requisição é a nova Relação de Grupos do 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: Retorna lista de colaboradores.
• 401 Not Authorized: Não autorizado.
• 404 Not Found: Colaborador não encontrado.