Objetivo.Conveniada.SGA.Cliente 2.5.0

Objetivo Conveniada - Cliente SGA (Sistema de Gestão Acadêmica)

Pacote para facilitar o uso da API para acessar dados e arquivos, referentes aos dados de acordo com seu nível de acesso.

Último release

Release 2.5.0 (2022-11-10)

Features

• Incluindo documentação básica.
• Melhorando o tratamento dos parâmetros de configuração.
• Adicionando parâmetros para indicar o tempo e origem para o token.
• Simplificando processo de publicação.
• Atualizando projeto de teste para .net 5.0.

Configuração

Para pode usar os recursos do pacote, são necessárias 3 (três) configurações:

• URL: (OBRIGATÓRIO) Informar a URL da API que irá ser carregada.
• Chave Pública: (OBRIGATÓRIO) Informar a chave pública de acesso a API.
• Autorização: (OBRIGATÓRIO) Informar a autorização de acesso a API que vai influênciar os recursos que você terá acesso.

É um Singleton, então só precisa ser atribuído um única vez dependendo da sua aplicação:

Objetivo.Conveniada.SGA.Cliente.Config.Url = "https://api.site.com.br/pasta/";
Objetivo.Conveniada.SGA.Cliente.Config.ChavePublica = "160MYEAto65UhwwrJsTtCBgVpwpj499CML4rK7y1bFpZLMudMk";
Objetivo.Conveniada.SGA.Cliente.Config.Autorizacao = "73oo41d94iPEQmeyScA5ApnthwH77b88pidsvxsHOKpMEtZGpz";

Chamando API

Um exemplo de teste de obter os dados da API.

using Xunit;
using System.Threading.Tasks;
using Objetivo.Conveniada.SGA.Cliente.Servicos;
using Objetivo.Conveniada.SGA.Cliente.ObjetosDeValor;

namespace Seu.Projeto.Csharp.Teste
{
    public class SobreServTeste
    {
        [Fact]
        public async Task Obter()
        {
            SobreServ serv = new();
            Sobre dados = await serv.ObterAsync();

            Assert.True(serv.EhValido());
            Assert.NotNull(dados);
        }
    }
}

Algumas chamadas precisam de parâmetros, e neste caso, há classes para mandar esses valores. Nesse exemplo, vou usar o serviço de filtro de séries.

using Xunit;
using System.Linq;
using System.Threading.Tasks;
using System.Collections.Generic;
using Objetivo.Conveniada.SGA.Cliente.Servicos;
using Objetivo.Conveniada.SGA.Cliente.Entidades;
using Objetivo.Conveniada.SGA.Cliente.Comandos.SerieCmds;

namespace Seu.Projeto.Csharp.Teste
{
    public class SerieServTeste
    {
        [Fact]
        public async Task Filtrar_serie_valido()
        {
            SerieServ serv = new();
            FiltrarCmd cmd = new()
            {
                Maximo = 1,
                Pagina = 1
            };
            Serie[] dados = await serv.FiltrarAsync(cmd);
            
            Assert.True(dados.Any());
            Assert.True(serv.EhValido());
        }

        [Fact]
        public async Task Filtrar_serie_invalido()
        {
            SerieServ serv = new();
            FiltrarCmd cmd = new()
            {
                Series = new List<string>() { "-1" },
                Maximo = 1,
                Pagina = 1
            };

            Serie[] dados = await serv.FiltrarAsync(cmd);
            Assert.False(dados.Any());
            Assert.False(serv.EhValido());
        }
    }
}