Skip to content

Commit 205544f

Browse files
ivmeloivmelo
committed
Melhora README
1 parent 96eeda9 commit 205544f

File tree

1 file changed

+9
-187
lines changed

1 file changed

+9
-187
lines changed

‎README.md‎

Lines changed: 9 additions & 187 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,13 @@
66
[![Total Downloads](https://poser.pugx.org/ivmelo/suap-api-php/downloads)](https://packagist.org/packages/ivmelo/suap-api-php)
77
[![License](https://poser.pugx.org/ivmelo/suap-api-php/license)](https://packagist.org/packages/ivmelo/suap-api-php)
88

9-
Um wrapper PHP para a API do [SUAP (Sistema Unificado de Administração Publica)](http://portal.ifrn.edu.br/tec-da-informacao/servicos-ti/menus/servicos/copy2_of_suap) do IFRN.
10-
11-
Este pacote permite que você tenha acesso aos dados do SUAP na sua aplicação PHP. http://suap.ifrn.edu.br/api/docs/
9+
Um wrapper PHP para a [API](http://suap.ifrn.edu.br/api/docs/) do [SUAP (Sistema Unificado de Administração Publica)](http://portal.ifrn.edu.br/tec-da-informacao/servicos-ti/menus/servicos/copy2_of_suap) do IFRN. Este pacote permite que você tenha acesso aos dados do SUAP na sua aplicação PHP.
1210

1311
É o componente principal do [SUAP Bot](https://telegram.me/suapbot).
1412

1513
Atualmente fornece informações de boletim (notas, frequência), cursos, horários, locais de aula e dados do aluno.
1614

17-
Este pacote foi atualizado para pegar os dados através da API oficial do SUAP, e não mais fazendo web scraping. Caso deseje utilizar a versão que faz web scraping, veja as tags 0.2.X.
15+
Este pacote foi atualizado para acessar os dados através da API oficial do SUAP, e não mais fazendo web scraping. Caso deseje utilizar a versão que faz web scraping, veja a tag `0.2.0`.
1816

1917

2018
### Instalação
@@ -151,6 +149,8 @@ $boletim = $suap->getMeuBoletim(2017, 1);
151149

152150
A saída será um array com informações sobre a disciplina encontradas no boletim do aluno.
153151

152+
Alunos do ensino superior só terão as notas da etapa 1 e 2.
153+
154154
```
155155
Array
156156
(
@@ -244,140 +244,7 @@ Array
244244
[media_final_disciplina] => 92
245245
)
246246
247-
[2] => Array
248-
(
249-
[codigo_diario] => 15361
250-
[disciplina] => TEC.0029 - Gerencia de Projetos
251-
[segundo_semestre] =>
252-
[carga_horaria] => 80
253-
[carga_horaria_cumprida] => 80
254-
[numero_faltas] => 2
255-
[percentual_carga_horaria_frequentada] => 98
256-
[situacao] => Aprovado
257-
[quantidade_avaliacoes] => 2
258-
[nota_etapa_1] => Array
259-
(
260-
[nota] => 50
261-
[faltas] => 2
262-
)
263-
264-
[nota_etapa_2] => Array
265-
(
266-
[nota] => 100
267-
[faltas] => 0
268-
)
269-
270-
[nota_etapa_3] => Array
271-
(
272-
[nota] =>
273-
[faltas] => 0
274-
)
275-
276-
[nota_etapa_4] => Array
277-
(
278-
[nota] =>
279-
[faltas] => 0
280-
)
281-
282-
[media_disciplina] => 80
283-
[nota_avaliacao_final] => Array
284-
(
285-
[nota] =>
286-
[faltas] => 0
287-
)
288-
289-
[media_final_disciplina] => 80
290-
)
291-
292-
[3] => Array
293-
(
294-
[codigo_diario] => 16586
295-
[disciplina] => TEC.0080 - Paradigmas de Linguagens de Programação
296-
[segundo_semestre] =>
297-
[carga_horaria] => 80
298-
[carga_horaria_cumprida] => 76
299-
[numero_faltas] => 30
300-
[percentual_carga_horaria_frequentada] => 61
301-
[situacao] => Aprovado
302-
[quantidade_avaliacoes] => 2
303-
[nota_etapa_1] => Array
304-
(
305-
[nota] => 74
306-
[faltas] => 12
307-
)
308-
309-
[nota_etapa_2] => Array
310-
(
311-
[nota] => 90
312-
[faltas] => 18
313-
)
314-
315-
[nota_etapa_3] => Array
316-
(
317-
[nota] =>
318-
[faltas] => 0
319-
)
320-
321-
[nota_etapa_4] => Array
322-
(
323-
[nota] =>
324-
[faltas] => 0
325-
)
326-
327-
[media_disciplina] => 84
328-
[nota_avaliacao_final] => Array
329-
(
330-
[nota] =>
331-
[faltas] => 0
332-
)
333-
334-
[media_final_disciplina] => 84
335-
)
336-
337-
[4] => Array
338-
(
339-
[codigo_diario] => 15362
340-
[disciplina] => TEC.0034 - Seminário de Orientação ao Projeto de Desenvolvimento de Sistema Coorporativo
341-
[segundo_semestre] =>
342-
[carga_horaria] => 40
343-
[carga_horaria_cumprida] => 40
344-
[numero_faltas] => 8
345-
[percentual_carga_horaria_frequentada] => 80
346-
[situacao] => Aprovado
347-
[quantidade_avaliacoes] => 2
348-
[nota_etapa_1] => Array
349-
(
350-
[nota] => 65
351-
[faltas] => 6
352-
)
353-
354-
[nota_etapa_2] => Array
355-
(
356-
[nota] => 65
357-
[faltas] => 2
358-
)
359-
360-
[nota_etapa_3] => Array
361-
(
362-
[nota] =>
363-
[faltas] => 0
364-
)
365-
366-
[nota_etapa_4] => Array
367-
(
368-
[nota] =>
369-
[faltas] => 0
370-
)
371-
372-
[media_disciplina] => 65
373-
[nota_avaliacao_final] => Array
374-
(
375-
[nota] =>
376-
[faltas] => 0
377-
)
378-
379-
[media_final_disciplina] => 65
380-
)
247+
...
381248
382249
[5] => Array
383250
(
@@ -437,6 +304,7 @@ $turmasVirtuais = $suap->getTurmasVirtuais(2017, 1);
437304
O método retornará um array com a lista de disciplinas do semestre atual junto com outras informações sobre as mesmas.
438305

439306
```
307+
Array
440308
(
441309
[0] => Array
442310
(
@@ -689,20 +557,7 @@ Array
689557
[time] => 07:00 - 07:45
690558
)
691559
692-
[2] => Array
693-
(
694-
[time] => 07:45 - 08:30
695-
)
696-
697-
[3] => Array
698-
(
699-
[time] => 08:50 - 09:35
700-
)
701-
702-
[4] => Array
703-
(
704-
[time] => 09:35 - 10:20
705-
)
560+
...
706561
707562
[5] => Array
708563
(
@@ -813,15 +668,7 @@ Array
813668
[time] => 19:00 - 19:45
814669
)
815670
816-
[2] => Array
817-
(
818-
[time] => 19:45 - 20:30
819-
)
820-
821-
[3] => Array
822-
(
823-
[time] => 20:40 - 21:25
824-
)
671+
...
825672
826673
[4] => Array
827674
(
@@ -837,20 +684,7 @@ Array
837684
...
838685
)
839686
840-
[4] => Array
841-
(
842-
...
843-
)
844-
845-
[5] => Array
846-
(
847-
...
848-
)
849-
850-
[6] => Array
851-
(
852-
...
853-
)
687+
...
854688
855689
[7] => Array
856690
(
@@ -860,18 +694,6 @@ Array
860694
)
861695
```
862696

863-
### Horários de Aula da Semana
864-
Para recuperar horários de aula da semana inteira, use o método ```getWeekSchedule()```.
865-
866-
Nos arrays retornados 1 representa o domingo, 2 a segunda, 3 a terça...
867-
868-
```php
869-
$client->getWeekSchedule()
870-
```
871-
872-
Isso retornará um array associativo usando os dias da semana, seguido pelo turno e horários como chave, e as informações do curso como valores.
873-
874-
875697
### E se ocorrer algum erro durante o request?
876698
Caso algum erro ocorra durante o request, o cliente HTTP lançará exceções. Isto inclui falha no login, 404, 500, etc...
877699

0 commit comments

Comments
 (0)