Download the PHP package ufvjm/graphql-client without Composer
On this page you can find all versions of the php package ufvjm/graphql-client. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package graphql-client
Client GraphQL - UFVJM
Uma biblioteca PHP para realizar requisições ao servidor GraphQL da UFVJM.
Sumário
- Client GraphQL - UFVJM
- Sumário
- Utilização da biblioteca
- Pré-requisitos
- Adicionar biblioteca como dependência
- Definir variáveis de ambiente
- Client Id e Client Key da Aplicação
- Nome do ambiente
- Autenticação na API
- Integrando a autenticação
- Exemplos de consultas
- Busca por código
- Busca de informações paginadas
- Carregando relacionamentos
- Contribuindo para a biblioteca
- Repositório
- Ferramentas
- Testes
- Documentação
- Equipe Responsável
- Parceiros
Utilização da biblioteca
Pré-requisitos
- PHP 7.1 ou superior
- Composer instalado e configurado
- Aplicação cadastrada no Portal do Desenvolvedor da UFVJM
Adicionar biblioteca como dependência
Na raíz do seu projeto, execute o composer
-
Via composer diretamente:
- Ou via container docker:
Definir variáveis de ambiente
Informar corretamente os valores abaixo para as variáveis de ambiente:
Client Id e Client Key da Aplicação
Lançar os valores corretos para os arquivos da integração com os microsserviços no arquivo .env.
Substituir os valores de GRAPHQL_APP_ID e GRAPHQL_APP_KEY para os valores cadastrados na stack de Microsserviços DTI/DDS:
Nome do ambiente
Define se o seu sistema apontará para o ambiente de testes
ou de produção
(sistema oficial da UFVJM).
-
Ambiente de Testes:
- Ambiente de Produção:
Após alterações no arquivo .env, o container web deve ser reiniciado para recarregar as alterações:
Autenticação na API
A autenticação é controlado por 2 tokens:
- Token de Aplicativo: aplicativo cadastrado e autorizado no Portal da API.
- Token de Usuário: usuário logado em sua Conta Institucional.
A Autenticação do aplicativo é realizada fornecendo o appId e appKey fornecidos quando você realiza o cadastro do seu aplicativo no Portal da API. A autenticação do usuário é relizada fornecendo o usuário e senha da Conta Institucional da UFVJM.
Quando a query de Autenticação é executada, serão retornados 2 tokens:
- um token de autenticação válido por 24 horas para o aplicativo
- e um token de usuário válido por 3 horas.
Essa biblioteca armazena o token retornado na sessão PHP e, a cada nova requisição esses tokens serão utilizados. Antes de cada requisição a biblioteca testa a validade do token e, quando for o caso, realiza sua renovação através de uma requisição de renovação.
Os tokens são do tipo JWT (JSON Web Token), o artigo O que é JSON Web Token? explica o seu funcionamento.
Integrando a autenticação
No início do arquivo:
Na função de autenticaçao:
Exemplos de consultas
Nos exemplos listados abaixo, a autenticação já foi realizado e os tokens de usuário e aplicação já estão salvos na sessão:
Busca por código
Buscando a disciplina de código COM001
Busca de informações paginadas
Busca uma lista de até 3 disciplinas
Carregando relacionamentos
Busca a disciplina de código COM001 e carrega o relacionamento departamento
Contribuindo para a biblioteca
Repositório
O desenvolvimento é realizado na branch dev
. Os mantenedores do respoitório levam as alterações aprovadas para a branch master
.
Ferramentas
Construindo a imagem, atualizando as bibliotecas e iniciando o container:
Executando as validações
Parando o container:
Testes
PHP Unit:
PHP Code Sniffer:
PHP Code Beauty Fixer:
PHP Mess Detector:
PHP Security Checker:
Documentação
Mais informações: Portal do Desenvolvedor
Equipe Responsável
Divisão de Desenvolvimento de Sistemas [email protected]
Parceiros
- PROGRAD - Sistema de Monitoria
- PROEXC - Sistema de Bolsas