- Deve estar disponível na internet através do protocolo https;
- Deve ser disponibilizada a documentação do serviço, preferencialmente no formato OpenAPI (ver Referências para Documentação de APIs);
- Deve ser disponibilizado ambiente de teste/homologação (não produtivo) para que seja possível testar a integração;
- Devem ser disponibilizadas credenciais de acesso, caso necessárias, para os ambientes de teste/homologação e produção;
- Deve ser cadastrado o certificado que foi fornecido pelo time do Conecta para que possa ocorrer o consumo do serviço, no caso onde a integração seja através de autenticação mútua;
- Deve ser informada a quantidade (capacidade) máxima de requisições por segundo que o serviço suporta;
- Deve ser definido o canal de comunicação com o suporte técnico do gestor do dado para que sejam informados possíveis problemas de indisponibilidade e/ou dúvidas durante a integração;
- Deve estar catalogada, ou em processo de catalogação, no Catálogo de APIs.
Para gerenciar o acesso a suas APIs, o órgão cedente de dados indicará um integrante, que será cadastrado pela equipe interna no perfil Gestor de APIs.
Para disponibilizar suas APIs, o Gestor de APIs deve:
Um plano de consumo é o nome da associação de uma API com um limite de consultas. Ele especifica a quantidade máxima permitida de acessos à API para o período de um ano (limite de consumo).
O Gestor de APIs pode realizar o controle de consumo de sua API através da definição de diferentes planos de consumo, que serão utilizados para limitar a consulta de diferentes órgãos recebedores de dados.
O cadastro de adesões à API permite que se conceda acesso a novos órgão às suas APIs gerenciadas.
Além dessas funcionalidades, o Gestor de APIs também pode:
Apresenta todos os planos de consumo cadastrados no Gerenciador de APIs do Conecta para este Gestor do Órgão.
Apresenta todos os órgãos cadastrados no Gerenciador de APIs do Conecta.
Cadastrar Gestor do órgão recebedor de dados
Permite que um integrante do órgão recebedor de dados seja cadastrado com o perfil Gestor de API no Gerenciador de APIs do Conecta.
Listar Gestor do órgão recebedor de dados
Apresenta todos os Gestores de APIs do órgão recebedor de dados.
Logue no Gerenciador de APIs utilizando sua Conta gov.br.
Tip
Pode-se acessar a conta tanto com senha ou certificado digital
Esta é a tela inicial para o perfil Gestor de APIs, após o mesmo ter sido autenticado pelo Acesso gov.br:
>> No menu Administração, selecionar o item Plano > Listar Planos de Consumo
- Os planos de consumo para as APIs do órgão provedordos dados podem ser filtrados de acordo com:
- Nome da API (incluindo todas);
- Nome do Plano de Consumo;
- Limite
- Situação
Após a escolha dos filtros, que é opcional, basta acionar o botão “Pesquisar” para gerar a lista dos planos de consumo de acordo com o critério de pesquisa definido pelos filtros.
Attention!
- A lista dos planos de consumo é apresentada em tela, com paginação e com as seguintes informações para cada plano de consumo:
- Nome da API
- Nome do Plano de Consumo
- Limite do Plano de Consumo
- Situação do Plano de Consumo
- A partir da lista, é possível executar as seguintes ações para cada item, conforme ilustrado na tela abaixo:
- Ativar/desativar o plano de consumo
- Alterar o plano de consumo
- Cadastrar adesão à API
A ação Ativar/desativar o plano de consumo faz com que o plano de consumo mude entre os estados ativado e desativado. Um plano de consumo ativado pode ser utilizado no cadastro de adesão de APIs, enquanto um desativado não permite a ação mencionada.
A ação Alterar o plano de consumo é similar à ação Cadastrar Plano de Consumo.
>> No menu Administração, selecionar o item Plano > Cadastro de Novo Plano de Consumo.
- Na tela de cadastro, o Gestor do Órgão deve:
- Associar o plano de consumo sendo criado com a API para a qual ele vai ser utilizado;
- Preencher os campos com as informações do nome do plano de consumo e o limite permitido para o plano em questão (em quantidade de consultas).
- Efetivar o cadastro pelo botão Incluir.
Será exibida mensagem com o resultado da realização da inclusão, na parte superior da tela, abaixo do menu. Caso a inclusão seja realizada com sucesso:
Após a inclusão de um plano de consulta, é possível alterá-lo por meio do botão apresentado na parte inferior direita da tela. A alteração é realizada da mesma forma que o cadastro, sendo que os campos são apresentados preenchidos com os dados correntes do plano de consumo para serem alterados.
>> A partir da ação Cadastrar adesão à API no item desejado da lista de planos de consumo (conforme descrito em Listar Planos de Consumo), são exibidas as adesões existentes e é possível cadastrar novas adesões.
A tela de cadastro apresenta todas as adesões existentes para o órgão provedor de dados. O Gestor do Órgão deve:
- Associar o nome da API ao plano de consumo desejado;
- Efetivar o cadastro pelo botão Incluir.
>> No menu Administração, selecionar o item Órgão > Listar Órgão
- Os órgãos cadastrados podem ser filtrados de acordo com:
- Nome do Órgão
- Situação
Após a escolha dos filtros, que é opcional, basta acionar o botão "Pesquisar" para gerar a lista dos órgãos de acordo com o critério de pesquisa definido pelos filtros.
- A lista dos órgãos é apresentada em tela, com paginação e com as seguintes informações para cada órgão:
- Nome do Órgão
- Sublista com as adesões existentes
- Situação
A partir da lista, é possível executar a seguinte ação para cada órgão, conforme ilustrado na tela abaixo:
No menu Administração, selecionar o item Gestor > Listar Gestores
- Os gestores podem ser filtrados de acordo com:
- Nome do Órgão
- Número do CPF
- Nome
Selecionar (drop-down) Após a escolha dos filtros, que é opcional, basta acionar o botão “Pesquisar” para gerar a lista dos gestores de acordo com o critério de pesquisa definido pelos filtros. A lista dos gestores é apresentada em tela, com paginação e com as seguintes informações para cada gestor:
- CPF
- Nome
- Órgão
- Data de início do período de gestão
- Data de fim do período de gestão
- A partir da lista, é possível executar as seguintes ações para cada gestor:
- Ativar/Desativar gestor
- Alterar os dados do gestor
Um gestor desativado fica impedido de realizar ações na plataforma, inclusive a geração de novas chaves de acesso.
A alteração dos dados do gestor, por meio da ação Alterar os dados do gestor, é realizada de forma similar ao cadastro dos gestores do órgão conforme descrito em Cadastrar Gestor do órgão recebedor de dados
>> No menu Administração, selecionar o item Gestor > Cadastro de Novo Gestor.
- Nesta tela, o Gestor do Órgão deve:
- Selecionar o órgão do gestor sendo cadastrado. Caso o órgão selecionado seja vinculado ao SIAPE:
- Informar o CPF do gestor;
- Utilizar o botão Pesquisar Servidor, que busca automaticamente os dados restantes de cadastro para o CPF informado.
- Efetivar o cadastro pelo botão Incluir.
- Caso o órgão selecionado NÃO seja vinculado ao SIAPE:
- Informar o CPF do gestor;
- Informar os dados de cadastro do gestor;
- Efetivar o cadastro pelo botão Incluir.
