Solicite a criação de uma API

Aqui você encontrará as informações sobre como solicitar a criação de uma API ou serviço para o seu projeto, e também como funciona o processo de avaliação da sua solicitação.

 

Passo 1 - Verificar APIs disponibilizadas

Acesse o Portal de Integração, verifique as APIs disponíveis. Caso elas não atendam sua necessidade e deseje solicitar a criação de uma API ou serviço para o seu projeto, clique na opção: 

 

Passo 2 - Preencher o formulário de Solicitação

Após clicar na opção para solicitar a criação de uma API, será exibido um formulário para solicitação de API em que você deverá preencher todas as informações necessárias para que sua solicitação seja avaliada e possa ser atendida. Com o formulário espera-se obter as seguintes informações:

 

• Nome completo - Nome completo solicitante;
• E-mail - E-mail para contato com o solicitante, para maiores esclarecimentos e resposta a solicitação;
• Solicitante - Identificação do solicitante quanto ao vínculo com a UFG: servidor, aluno ou externo. 
• Nome da API - Sugestão de nome para sua API
• Descrição da API - descrição detalhada da API, com informações da finalidade e objetivo da API, bem como as informações esperadas.
• Justificativa - descrição da justificava para construção da api, necessidades que serão atendidas, resultados esperados com a integração.
• Informações necessárias - Indicar quais e como é esperada a disponibilização dos dados, exemplo da estrutura do objeto JSON exemplificando os dados esperados 
• Observações - espaço destinado para detalhamento de alguma questão relacionada a API.

 

Além dessas informações sobre a API, é preciso indicar se você que está realizando a solicitação da API será o responsável pelo uso da API, para eventuais contatos e esclarecimentos sobre a API. Caso não seja você o responsável, é preciso indicar os dados de contato do responsável.

 

Passo 3 - Verificar Termos de Uso

Por fim, é preciso que verifique os Termos de Uso do Portal de Integração e concorde com os termos apresentados. Após concordar com o termos de uso, basta clicar no botão Registrar, para que sua solicitação seja enviada para avaliação da equipe responsável. Posteriormente, você será contactado para saber se sua solicitação foi aprovada ou não. 

 

Para conhecer melhor o nosso fluxo de trabalho e como é realizado o atendimento de solicitações relacionadas a criação de APIs ou serviços, liberação de acesso a APIs e serviços já existentes, dentre outras demandas, disponibilizamos os fluxos dos principais processos relacionados as demandas por APIs ou serviços: