README

此项目实现了对SUAP API的包装。目的是提供处理SUAP API提供功能的PHP代码。这样，就可以使用PHP方式构建使用SUAP API的PHP应用程序。

如何安装

可以通过以下命令从packagist.org安装此包

composer require "composer require romeritocampos/suap-php-api:dev-master"

如何使用

该包有两个模块。第一个模块定义在Romerito\Suap命名空间下。此模块包含用于调用SUAP API并访问数据的类。第二个模块定义在Romerito\model命名空间下，其类用于将信息表示为对象。

授权

授权过程需要用户凭据。以下代码展示了如何验证用户凭据以及在使用有效信息的情况下访问生成的令牌。

<?php 
	require __DIR__ . "/vendor/autoload.php";
	use Romerito\Suap\SuapClient;
	$client = new SuapClient;
	#user credentials
	$user = readline();
	$pass = readline();
	#true or false
	$res = $client->auth ($user, $pass);
	#generated token
	$token = $client->getToken();
	echo $token . "\n";

一般调用

或者，可以使用API提供的URL，如下所示

    	require __DIR__ . "/vendor/autoload.php";
	use Romerito\Suap\SuapClient;
	$client = new SuapClient;
	$user = readline();
	$pass = readline();
	if ($client->auth ($user, $pass)) {
		$result = $client->get("/minhas-informacoes/meus-dados/");
		var_dump($result);
	}

需要注意的是，提供的URL有时需要一些参数，因此必须构建URL并将其传递给get()方法。这些详细信息需要在SUAP API上检查。

使用ProfessorClient

该包提供了一个类来处理对特定资源 - 教授的调用。到目前为止，可以通过使用ProfessorClient类获取与教授关联的个人资料和学籍登记册。这可以通过使用ProfessorClient类来完成。

以下代码展示了如何使用ProfessorClient类调用SUAP API

<?php
	require __DIR__ . "/vendor/autoload.php";
	use Romerito\Suap\SuapClient;
	use Romerito\Suap\ProfessorClient;
	$client = new SuapClient;
	$user = readline();
	$pass = readline();
	$client->auth($user, $pass);
	$pclient = new ProfessorClient($client);
	$object = $pclient->getProfessorObject();
	echo  get_class($object) . "\n";