claudsonm / ufs-apisistemas

v1.2.2 2018-10-06 03:50 UTC

Requires

• ext-json: *
• guzzlehttp/guzzle: ^6.3

Requires (Dev)

• vlucas/phpdotenv: ^2.5

MIT

• Claudson Martins

Published on Packagist.org on 2018-10-06 03:52 UTC

README

Um simples pacote para consumir os serviços disponibilizados pela API da UFS (Universidade Federal de Sergipe).

Instalação

Na pasta do seu projeto, execute o comando composer require claudsonm/ufs-apisistemas.

Exemplo de Utilização

require 'vendor/autoload.php';

// Obtenção das client credentials para consumir serviços públicos
$credentials = \UFS\APISistemas::getClientCredentials(
    env('UFS_KEY'),
    env('UFS_SECRET'),
    null,
    true
);

// Inicialização com o Access Token obtido
$api = new \UFS\APISistemas($credentials['access_token'], true);

// Realização de uma requisição ao endpoint solicitado com um query parameter
$result = $api->get('departamentos', ['limit' => 10]);

// Altera o tipo de retorno para um objetivo ao invés de um array associativo
$result = $api->get('departamentos', ['limit' => 10, 'assoc_decode' => false]);

/**
 * MÉTODOS DISPONÍVEIS
 * Para acessar endpoints privados será necessário utilizar a classe com um
 * access_token de usuário.
 */

// Obtendo os dados do usuário logado
$result = $api->self();

// Realização de uma requisição a um arquivo
$result = $api->arquivo(env('FILE_ID'), env('FILE_KEY'));

header('Content-Type: application/json');
echo json_encode($credentials + $result);