O que é uma API e como posso utilizar a documentação para entender seu funcionamento?

Olá, tudo bem? Esperamos que sim!
Nesse artigo aprenderemos o que é uma API, quais seus princípios, como funciona uma API REST e como podemos testá-la.

Neste artigo você encontrará:

• O que é API
• Mas e o que seria uma API no modelo REST?
• E como posso usar a documentação?
• E então quando posso usar uma API?
• Material em vídeo
• Artigos relacionados

A Proesc disponibiliza uma API, no modelo REST. Por meio dessa interface, é possível conversar com o sistema da Proesc, comandando ações e consultando informações referente as instituições de ensino que utilizam o sistema, mas começaremos pelo que de fato é uma API.

O que é API

A interface de programação de aplicação (API), é um conjunto de padrões e protocolos que promovem a conexão entre um usuário e uma aplicação, permitindo que ele acesse e faça uso das funcionalidades do software em questão, sem que ele precise dos detalhes da estrutura e do desenvolvimento do sistema que está tentando utilizar.

Funciona basicamente como um comunicador, entre o usuário e o sistema. Deste modo, ela facilita o acesso e o desenvolvimento de aplicações para a internet.

Mas e o que seria uma API no modelo REST?

Ela é um tipo de arquitetura para desenvolvimento das APIs, baseada no protocolo HTTP e são amplamente utilizadas em aplicações web e móveis para fornecer uma interface padronizada e acessível a serviços e dados de uma aplicação. Elas são altamente flexíveis e podem ser consumidas por diferentes tipos de clientes, desde navegadores web até aplicativos móveis, além de permitir a integração com outras aplicações de terceiros.

Essa categoria é centrada na ideia de recursos (ex: usuários, produtos), que podem ser manipulados mediante operações padrão, como GET, POST, PUT e DELETE. Vale ressaltar que nessa API disponibilizada, será possível efetuar apenas chamadas com uma requisição HTTP do tipo GET.

Resumindo, a categoria REST apresenta alguns critérios específicos, que visam padronizar e flexibilizar essa comunicação entre o usuário e o sistema de maneira confiável e em diferentes plataformas.

E como posso usar a documentação?

O primeiro passo para testar o funcionamento da API será acessar este link que contém a documentação completa. Ao acessar você será direcionado(a) para a seguinte tela:

Observe que na lateral esquerda temos os tópicos Iniciando a integração que contém a Introdução à API e Autenticação e a PROESC API (que está dividida em 4 subitens: Geral, Pedagógico, Financeiro e Carga de Dados. Anteriormente, as consultas eram feitas separadamente, mas para facilitar o acesso e leitura dos dados a API foi unificada entre esses 3 setores que englobam todas as informações registradas no sistema.

Na página principal (Introdução à API) se encontram algumas informações sobre a API e o endereço base para a comunicação com ela, que é https://api.proesc.com/api/v2/.

Abaixo temos o tópico Autenticação, e é nele geraremos o token de acesso (que oferece comunicação segura e confiável) para efetuar nossos testes. O processo é simples, basta seguir as instruções contidas nessa aba para gerar seu token.

Agora vamos aos testes na API. Com o token em mãos preencheremos os campos indicados para ter acesso a API, no exemplo a seguir estou utilizando a API do setor GERAL.

Como explicado a aba Autenticação e indicado na lateral direita da página, vou incluir o token gerado no campo Header:

Perceba que ainda temos alguns campos opcionais para ajudar na busca específica de dados, na tela temos o item Query Params que são parâmetros que podem ser preenchidos para facilitar sua busca.

Para ter acesso a todos esses dados que estão disponíveis para preenchimento, tanto na API Geral, Pedagógico e Financeiro, basta acessar a aba Carga de Dados. Através dela você terá todas as informações solicitadas nas querys, como unidade_id, class_id, invoice_type_id, entre outras. Basta utilizar seu token de acesso e seguir o mesmo passo anterior. Ao clicar em Try It! Você terá o retorno com todos os dados.

Cada um dos setores retornam diversos dados, que podem ser usados por você e/ou pelo time tecnológico de sua instituição de ensino, ou até para integrar esses dados a outros sistemas, caso seja necessário.

E então quando posso usar uma API?

Caso você tenha um time de contabilidade, você pode acessar a API Financeiro, que retornam dados importantes, como Listagem de parcelas dos alunos com dados dos boletos, por exemplo. Assim o sistema desejado pode utilizar a API da Proesc para integrar as informações desejadas.

Caso tenha alguma dúvida técnica, você poderá enviar um e-mail para contato@proesc.com para obter o suporte necessário para utilização da API e integração com o sistema.

Material em vídeo

ARTIGOS RELACIONADOS

• Como acessar e copiar a API para a integração com outros sistemas.
• Integração ClipEscola + Proesc

Gostou? Então que tal você checar outros artigos da nossa Base de Conhecimento? Basta acessar base.proesc.com.

Até a próxima 🚀💚