Pular para o conteúdo principal

Chaves de API

GET​

  • /api-keys
  • /api-keys/:id

Retorna os dados das aplicações cadastradas no sistema de acordo com os parâmetros da requisição.

Authorization​

  • Authorization: Bearer <session_token>

Parâmetros​

  • blocked (Opcional): true ou false filtro para pegar as aplicações que estão bloqueadas.
  • name (Opcional): Nome da aplicação.
  • optFields (Opcional): Dados adicionais das aplicações (email, labels, permissions ).
  • token (Opcional): Token da aplicação.

Os parâmetros de filtragem são enviados na query string.

Caso id não seja passado na url, todas as aplicações serão retornadas.

Resultado​

O resultado de uma requisição bem sucedida será um 200 Ok com o seguinte formato:

Array<{
  blocked: boolean;
  creationTimestamp: Date;
  dnsName: string;
  id: number;
  name: string;
  organizations: Array<{
    creationTimestamp: Date;
    lastUseTimestamp: Date;
    short: string;
  }>;
  token: {
    id: number;
    name: string;
  };
  updateTimestamp: Date | null;
}>;

POST​

  • /api-keys

Cadastra uma nova aplicação no sistema.

Authorization​

  • Authorization: Bearer <session_token>

Parâmetros​

  • dnsName (Opcional): Nome que servirá como usuário para acessar serviço SFTP
  • emails: Emails para quais a aplicação mandará notificações
  • name: Nome da aplicação
  • organizationsIds: Organizações que a aplicação terá acesso
  • permissions: Quais recursos a aplicação terá permissão para acessar

Os parâmetros do body da requisição tem o seguinte formato:

{
 "dnsName": string,
 "emails": Array<string>,
 "name": string,
 "organizationsIds": Array<number>,
 "permissions": ["accessFtp", "editLabels"]
}

Resultado​

O resultado para uma requisição bem sucedida será um 201 Created com o seguinte formato:

{
 "blocked": boolean;
 "creationTimestamp": Date;
 "dnsName": string;
 "id": number;
 "name": string;
 "token": {
  "creationTimestamp": Date;
  "lastUseTimestamp": null;
  "short": string;
  "value": string;
 };
 "updateTimestamp":  null;
}

PATCH​

  • /api-keys/:id

Atualiza os dados de uma aplicação cuja o id é aquele passado na url.

Authorization​

  • Authorization: Bearer <session_token>

Parâmetros​

  • blocked (Opcional): Status da aplicação no sistema.
  • dnsName (Opcional): Nome que servirá como usuário para acessar serviço SFTP.
  • emails (Opcional): Emails para quais a aplicação mandará notificações.
  • labels (Opcional): VERIFICAR.
  • name (Opcional): Nome da aplicação.
  • organizationsIds (Opcional): Organizações que a aplicação terá acesso.
  • permissions (Opcional): Quais recursos a aplicação terá permissão para acessar.
  • refreshApiToken (Opcional): Parâmetro para atualizar o token da aplicação.

Os parâmetros do body da requisição tem o seguinte formato:

{
 "blocked": boolean;
 "dnsName": string;
 "emails": Array<string>;
 "labels": **VERIFICAR**;
 "name": string;
 "organizationIds": Array<number>;
 "permissions": ["accessFtp", "editLabels"];
 "refreshApiToken": boolean;
}

Resultado​

O resultado para uma requisição bem sucedida será um 200 Ok com o seguinte formato:

{
 "blocked": boolean;
 "id": number;
 "isValid": boolean;
 "name": string;
 "token": {
  "creationTimestamp": Date;
  "lastUseTimestamp": Date | null;
  "short": string;
  "value": string;
 };
 "updateTimestamp":  Date | null;
}

DELETE​

  • /api-keys/:id

Remove a aplicação do sistema cuja o id é aquele passado na url.

Authorization​

  • Authorization: Bearer <session_token>

Resultado​

O resultado de uma requisição bem sucedida será um 200 Ok com body vazio.