Apikey

Esta é uma API de gerenciamento de chaves de integração, também chamado de apikey.

Listar Apikeys Paginadas

API de listagem de apikeys paginadas. Ver documentação de paginação.

GET /api/3rdparty/apikeys

GET /api/3rdparty/apikeys?cursor=0&size=15

Exemplo de requisição

GET /api/3rdparty/apikeys HTTP/1.1
Host: api.exemplo.com
Accept: application/json
Authorization: Bearer <Access-Token>

from itflex_sdk.auth.types import GetApikeyPageRequest

request = GetApikeyPageRequest(cursor=0, size=15)
pages = sdk.auth.get_apikeys_pages(request)

const pages = sdk.auth.getApiKeysPages();
const response = await pages.next();
console.log(response.payload);

Exemplo de resposta

HTTP/1.1 200 OK
Content-Type: application/json

{
  "cursor": {"current": 0, "next": null, "previous": null},
  "apikeys": [
    {
      "id": 1,
      "name": "apikey",
      "superuser": true,
      "roles": [],
      "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9",
    }
  ],
}

page = pages.next()
page = pages.previous()

# retornar os itens de uma página
for apikey in page.apikeys:
    print(apikey)

# retornar os itens de todas as páginas
for apikey in pages:
    print(apikey)

[
  {
    id: 1,
    name: "apikey",
    token: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9",
    superuser: true,
    roles: []
  }
];

Buscar Apikey

API de busca de uma apikey existente.

GET /api/3rdparty/apikeys/<id>

Exemplo de requisição

GET /api/3rdparty/apikeys/1 HTTP/1.1
Host: api.exemplo.com
Accept: application/json
Authorization: Bearer <Access-Token>

from itflex_sdk.auth.types import GetApikeyRequest

request = GetApikeyRequest(id=1)
response = sdk.auth.get_apikey(request)

const response = await sdk.auth.getApiKey({ id: 1 });
console.log(response.payload);

Exemplo de resposta

HTTP/1.1 200 OK
Content-Type: application/json

{
  "id": 1,
  "name": "apikey",
  "superuser": true,
  "roles": [],
  "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9",
}

if response.success:
    return response.apikey

{
  id: 1,
  name: "apikey",
  token: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9",
  superuser: true,
  roles: [],
}

Cadastrar Apikey

API de cadastro de apikeys.

POST /api/3rdparty/apikeys

Exemplo de requisição

POST /api/3rdparty/apikeys HTTP/1.1
Host: api.exemplo.com
Accept: application/json
Authorization: Bearer <Access-Token>

{
  "name": "apikey",
  "superuser": true,
  "roles": [],
}

from itflex_sdk.auth.types import CreateApikeyRequest

request = CreateApikeyRequest(
            name="apikey",
            superuser=True,
            roles=[],
          )
response = sdk.auth.create_apikey(request)

const apikey = sdk.auth.types.ApiKey();
apikey.name = "Docs sample";
apikey.superuser = true;

const response = await sdk.auth.createApiKey(apikey);
console.log(response.payload);

Exemplo de resposta

HTTP/1.1 200 OK
Content-Type: application/json

{
  "id": 1,
  "name": "apikey",
  "superuser": true,
  "roles": [],
  "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9",
}

if response.success:
    return response.apikey

{
  id: 2,
  name: "Docs sample",
  superuser: true,
  roles: []
}

Editar Apikey

API de edição de uma apikey existente.

PUT /api/3rdparty/apikeys/<id>

Exemplo de requisição

PUT /api/3rdparty/apikeys/1 HTTP/1.1
Host: api.exemplo.com
Accept: application/json
Authorization: Bearer <Access-Token>

{
  "name": "apikey-updated",
  "superuser": false,
  "roles": [1],
}

from itflex_sdk.auth.types import UpdateApikeyRequest

request = UpdateApikeyRequest(
        id=1,
        name="apikey-updated",
        superuser=False,
        roles[1],
    )
response = sdk.auth.update_apikey(request)

const apikey = {
  id: 1,
  name: "Docs sample edited",
  superuser: true,
  roles: []
};

const response = await sdk.auth.updateApiKey(apikey);
console.log(response.payload);

Exemplo de resposta

HTTP/1.1 200 OK
Content-Type: application/json

{
  "id": 1,
  "name": "apikey-updated",
  "superuser": false,
  "roles": [
    {
      "id":1,
      "name":"Users management"
    },
  ],
  "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9",
}

if response.success:
    return response.apikey

{
  id: 2,
  name: "Docs sample edited",
  superuser: true,
  roles: []
}

Excluir Apikey

API de exclusão de uma apikey existente.

DELETE /api/3rdparty/apikeys/<id>

Exemplo de requisição

DELETE /api/3rdparty/apikeys/1 HTTP/1.1
Host: api.exemplo.com
Accept: application/json
Authorization: Bearer <Access-Token>

from itflex_sdk.auth.types import DeleteApikeyRequest

request = DeleteApikeyRequest(id=1)
response = sdk.auth.delete_apikey(request)

const response = await sdk.auth.deleteApiKey({ id: 2 });

Exemplo de resposta

HTTP/1.1 200 OK
Content-Type: application/json

return response.success:

Formato dos dados

Parâmetros da url

Parâmetro Tipo
id integer

Requisição

Parâmetro Tipo Valor Dafault Descrição
id integer Identificador da apikey
name string requerido Nome completo da apikey
superuser boolean False Flag que identidica se o usuário tem permissões de superusuário
roles array<Role> Perfils de permissões do usuário

Resposta

Parâmetro Tipo Descrição
id integer Identificador da apikey
name string Nome completo da apikey
superuser boolean Flag que identidica se o usuário tem permissões de superusuário
roles array<Role> Perfils de permissões do usuário