Documentação
Trabalhando Com APIs UFG
O portal de integração UFG oferece um conjunto de APIs (Interface de programas de aplicação) que permite integrar os dados da UFG aos seus projetos.
Estamos empolgados em trabalhar com você para inovar na próxima geração de aplicativos usando nossas APIs disponibilizadas no Portal de Integração UFG. A seguir, são descritos os processos envolvendo nossas APIs e o que é preciso para integrar nossos serviços ao seu projeto na prática. Explore os detalhes abaixo.
Ambientes
Cada API dispõe de um ambiente de testes, denominado SANDBOX que deverá ser usado durante o processo de desenvolvimento da sua aplicação e o ambiente de produção que deverá ser usado após a homologação da sua aplicação e a liberação do token de produção. Abaixo são apresentados as URLs base para estes ambientes:
SANDBOX
A URL base para o ambiente de testes da API:
PRODUÇÃO
A URL base para o ambiente de produção da API:
Criação de conta
Para ter acesso aos recursos disponibilizados pelas APIs, é necessário possuir uma conta de desenvolvedor no Portal de Integração UFG.
Atualmente, a conta de desenvolvedor é criada quando o usuário solicita o acesso a alguma API do nosso catálogo via formulário, ou quando o usuário solicita a criação de uma API ou serviço também via formulário, preenchendo todos os campos necessários e finalize o processo. Após a solicitação você receberá por e-mail suas credenciais de acesso ao portal de Integração UFG.
Criação de APPs
Para criação da APP, a ação deverá ser realizada diretamente no Portal de Integração, conforme demonstrado no tutorial XXX.
Autenticação
A autenticação das APIs do portal de integração é realizada obrigatoriamente com um client_id e um token, formando assim as informações do cabeçalho (header) das requisições. Os seguintes dados são esperados em cada requisição:
client_id: Identificação da APP. Sua geração ocorre no momento da criação da APP pelo painel do desenvolvedor. Seu valor pode ser visualizado na coluna Token da lista de APPs e, poderá ser utilizado tanto em Sandbox quanto em Produção, após a aplicação passar pelo processo de homologação.
access_token: Identificação do token de acesso, que armazena as regras de acesso permitidas à APP. Sua geração ocorre em dois momentos no processo de integração com as APIs.
Erros de Autenticação
Alguns erros serão tratados durante a autenticação da chave de acesso. Abaixo a lista dos erros:
Ausência de header: O client_id e o access_token devem ser passados em todas as requisições, obrigatoriamente. Caso um deles esteja ausente, será retornado o erro 401 Unauthorized.
Inexistente/errado: Se qualquer um dos dados do header (client_id e/ou token) passados não existir ou estiver incorreto ou incompleto, será retornado o erro 401 Unauthorized.
Tokens expirados (inválidos): Se o access_token estiver expirado ele será considerado inválido e retornará o erro 403 Forbidden.
Tokens revogados (inválidos): Se o access_token estiver revogado ele será considerado inválido e retornará o erro 401 Forbidden.
Obtenção da chave de acesso - Token
Você poderá realizar a geração da chave de acesso diretamente no Portal de Integração, conforme demonstrado no tutorial XXX.