API SCA-GPS v1.0

Documentação dos endpoints disponíveis na API de gerenciamento de solicitações entre a aplicação do Cliente e o Sistema de Controle de Acesso.

Headers de autenticação

O header abaixo é obrigatório e deve ser enviado em todos os endpoints da API.

Header	Tipo	Obrigatório	Descrição
access-token	string	Sim	Token de autenticação para acesso à API

Caso o access-token não seja informado ou seja inválido, a API retornará erro 401 – Unauthorized.

O access-token será informado pelo time da GPS e deverá ser mantido em sigilo.

Summary: Listar todos os sites cadastrados no SCA

[
  {
    "id": 1,
    "description": "GRUPO GPS"
  }
]

Summary: Buscar sites por descrição

Nome	Local	Obrigatório
ARCOR	query	Sim

[
  {
    "id": 2,
    "description": "ID LOGISTICS ARCOR"
  }
]

Summary: Listar todas as zonas

{
  "id": 4,
  "name": "CABINE ID LOGISTICS KENVUE MG",
  "account_id": 1007,
  "status": true
}

Summary: Buscar zonas por nome

Nome	Local	Obrigatório
PORTA	query	Sim

{
  "id": 7,
  "name": "PORTA PRINCIPAL",
  "account_id": 1012,
  "general": false,
  "status": true
}

Summary: Criar ou alterar pessoa e associar as zonas que terá acesso

{
  "full_name": "string",
  "document": "string",
  "status": true,
  "zones": [1,5]
}

{
  "message": "Requisição aceita",
  "request_id": 106
}

Summary: Atualizar foto da pessoa

{
  "document": "string",
  "img_base64": "string"
}

{
  "message": "Requisição aceita",
  "request_id": 106
}

Summary: Healthcheck da API

{
  "status": "ok"
}

Os erros abaixo podem ocorrer em qualquer endpoint da API.

{
  "detail": "Pelo menos uma zona deve ser informada."
}

{
  "detail": "Usuário não autorizado"
}

{
  "detail": [
    {
      "loc": ["string", 0],
      "msg": "string",
      "type": "string"
    }
  ]
}