Pular para o conteúdo principal

Informações Gerais

Request URL​

O URL base usado para a API EKOS é formatado conforme mostrado abaixo:

https://prd-gestaodeoperacoes.jacto.com/api/

Cabeçalhos​

Uma solicitação HTTP típica para a API EKOS inclui os seguintes cabeçalhos:

  • Content-Type: Cada solicitação deve incluir um Content-Typecabeçalho.

  • Api-Token: O token de API ou um token é necessário para a atutenticação das solicitações de API.

info

A API EKOS suporta os seguintes verbos HTTP:

  • HTTP POST: utilizado para criar registro em banco de dados;

  • HTTP GET: utilizado para a leitura de registros em banco de dados;

  • HTTP PUT: utilizado para atualizar um determinado registro em banco de dados;

  • HTTP DELETE: utilizado para deletar um determinado registro em banco de dados.

Permissões​

Tipos de Usuários e Perfis​

A API requer autenticação e autorização com diferentes perfis de usuário, cada um com permissões específicas. Os perfis determinam o nível de acesso e as ações que cada usuário pode realizar nos endpoints.

Perfis de Usuário​

Os perfis disponíveis são:

  • USER_PROFILE_CLIENT_COMMON: Perfil comum para clientes.
  • USER_PROFILE_JACTO_COMMON: Perfil comum para usuários gerais da Jacto.
  • USER_PROFILE_JACTO_ADMIN: Perfil administrativo para usuários da Jacto.
  • USER_PROFILE_JACTO_TECHNICAL: Perfil técnico para usuários da Jacto.
  • USER_PROFILE_JACTO_SUPPORT: Perfil de suporte para usuários da Jacto.
  • USER_PROFILE_JACTO_DEVELOPER: Perfil de desenvolvedor para usuários da Jacto.
  • USER_PROFILE_SOIL_ADMIN: Perfil administrativo específico para usuários de Soil.

Categorização dos Perfis​

Alguns perfis podem ser agrupados para simplificar a lógica de permissão:

  • Perfil de Cliente: Todos os perfis cujo nome contém "CLIENT".
  • Perfil Jacto: Todos os perfis cujo nome contém "JACTO".
  • Perfil Soil: Todos os perfis cujo nome contém "SOIL".

Escopos e Requisitos de Autorização​

Os endpoints podem exigir permissões específicas baseadas nos perfis acima. Certifique-se de que o perfil do usuário está adequado ao escopo de acesso do endpoint desejado.

Escopos de Autorização​

  • Leitura (READ): Permite visualizar dados. Disponível para perfis comuns.
  • Escrita (WRITE): Permite modificar dados. Geralmente reservado para perfis administrativos e técnicos.
  • Administração (ADMIN): Acesso total, permitindo operações de criação, atualização e exclusão. Reservado para USER_PROFILE_JACTO_ADMIN e USER_PROFILE_SOIL_ADMIN.

Requisitos de Autenticação​

A API utiliza tokens de autenticação para garantir que apenas usuários autorizados possam acessar recursos específicos. Inclua o token de autenticação no header Authorization ao fazer solicitações.

Exemplo de Header de Autenticação​

Authorization: Bearer {token}

Integrações​

Conteúdo em Desenvolvimento...