https://github.com/claudsonm/ufs-apisistemas

Um simples pacote para consumir os serviços da APISistemas da UFS.
https://github.com/claudsonm/ufs-apisistemas

api api-client apisistemas composer-package packagist php ufs

Last synced: 17 days ago
JSON representation

Um simples pacote para consumir os serviços da APISistemas da UFS.

• Host: GitHub
• URL: https://github.com/claudsonm/ufs-apisistemas
• Owner: claudsonm
• License: mit
• Created: 2018-09-02T15:30:15.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2018-10-06T03:52:02.000Z (about 6 years ago)
• Last Synced: 2024-11-18T07:48:39.820Z (about 1 month ago)
• Topics: api, api-client, apisistemas, composer-package, packagist, php, ufs
• Language: PHP
• Homepage: https://packagist.org/packages/claudsonm/ufs-apisistemas
• Size: 27.3 KB
• Stars: 0
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# UFS APISistemas

[![Latest Version](https://badgen.net/github/release/claudsonm/ufs-apisistemas)](https://github.com/claudsonm/ufs-apisistemas/releases)

[![Total Downloads](https://poser.pugx.org/claudsonm/ufs-apisistemas/downloads)](https://packagist.org/packages/claudsonm/ufs-apisistemas)

[![License](https://poser.pugx.org/claudsonm/ufs-apisistemas/license)](https://packagist.org/packages/claudsonm/ufs-apisistemas)

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

```php

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);

```