Licensed to João Miguel Gil Veiga Salgues - [email protected] - 089.751.

274

INTRODUÇÃO
ÀS APIS: GUIA
BÁSICO PARA
INICIANTES

www.marcioguinati.com
Licensed to João Miguel Gil Veiga Salgues - [email protected] - 089.751.274

SÚMARIO

Capítulo 1: O que é uma API?

1.1 O conceito de API
1.2 Por que as APIs são importantes?

Capítulo 2: Tipos de APIs

2.1 API baseada em REST
2.2 Outros tipos de APIs

Capítulo 3: Fundamentos API

3.1 Requisições HTTP
3.2 Métodos HTTP comuns

Capítulo 4: Consumindo uma API

4.1 Realizando requisições HTTP
4.2 Analisando a resposta da API

Capítulo 5: Documentação de APIs

5.1 Importância da documentação
5.2 Exemplos de documentação de APIs

Capítulo 6: Boas práticas no uso de APIs

6.1 Lidando com limites e cotas de API
6.2 Gerenciando autenticação e chaves de API

www.marcioguinati.com
Licensed to João Miguel Gil Veiga Salgues - [email protected] - 089.751.274

SÚMARIO

Capítulo 7: Mão na massa

7.1 Integrando com a API do VIACEP
7.2 Criando uma API com JSON Server, com
requisições de GET, POST, DELETE e PATCH.

www.marcioguinati.com
Licensed to João Miguel Gil Veiga Salgues - [email protected] - 089.751.274

INTRODUÇÃO

Bem-vindo ao ebook "Introdução às APIs: Guia

Básico para Iniciantes". Neste guia, você será
apresentado aos conceitos fundamentais das APIs
(Interfaces de Programação de Aplicativos) e como
elas facilitam a comunicação entre diferentes
sistemas. Se você está começando no mundo da
programação ou deseja entender o básico sobre
APIs, este ebook é perfeito para você. Vamos
começar essa jornada de aprendizado juntos!

www.marcioguinati.com
Licensed to João Miguel Gil Veiga Salgues - [email protected] - 089.751.274

CAPÍTULO 1: O QUE É UMA API?

1.1 O conceito de API:

Uma API, ou Interface de Programação de Aplicativos,
é um conjunto de regras e protocolos que permite
que diferentes sistemas se comuniquem e
compartilhem informações entre si. Ela define a
maneira pela qual um software pode interagir com
outros softwares, permitindo o acesso e a troca de
dados de forma padronizada e segura. A API atua
como um intermediário, fornecendo uma interface
consistente e predefinida para que os
desenvolvedores possam utilizar os recursos de um
determinado serviço ou aplicativo.

1.2 Por que as APIs são importantes?

As APIs desempenham um papel fundamental na
integração de sistemas e no desenvolvimento de
aplicativos modernos. Elas permitem que os
desenvolvedores aproveitem funcionalidades
prontas e serviços de terceiros, sem precisar
reinventar a roda. Ao utilizar APIs, é possível acessar
recursos, como dados, funcionalidades e serviços, de
outras empresas ou plataformas, e incorporá-los aos
seus próprios aplicativos de forma fácil e eficiente.

www.marcioguinati.com
Licensed to João Miguel Gil Veiga Salgues - [email protected] - 089.751.274

CAPÍTULO 1: O QUE É UMA API?

As APIs tornam possível a interconectividade entre

diferentes sistemas, facilitando a criação de soluções
mais complexas e completas. Elas permitem a
integração de serviços, como autenticação,
pagamento, redes sociais, geolocalização, entre
outros, ampliando as possibilidades de um aplicativo
e melhorando a experiência do usuário.

Além disso, as APIs promovem a reutilização de

código e a colaboração entre desenvolvedores, já
que um serviço pode disponibilizar sua
funcionalidade através de uma API pública,
permitindo que outros desenvolvedores construam
aplicativos que se integrem facilmente a esse
serviço.

Em resumo, as APIs são essenciais para criar

aplicativos modernos e escaláveis, aproveitando
recursos externos, simplificando a integração entre
sistemas e acelerando o processo de
desenvolvimento.

www.marcioguinati.com
Licensed to João Miguel Gil Veiga Salgues - [email protected] - 089.751.274

CAPÍTULO 2: TIPOS DE APIS

2.1 API baseada em REST: Uma das formas mais

comuns de APIs é a baseada em REST
(Representational State Transfer). Essa arquitetura
utiliza os princípios fundamentais da web, como o
protocolo HTTP (Hypertext Transfer Protocol), para
fornecer uma interface de comunicação entre
diferentes sistemas. As APIs REST são projetadas
para serem simples, escaláveis e facilmente
compreensíveis.

Nesse tipo de API, os recursos são identificados por

URLs (Uniform Resource Locators) e podem ser
acessados através de diferentes métodos HTTP,
como GET, POST, PUT e DELETE. O acesso aos
recursos é feito por meio desses métodos,
permitindo a leitura, criação, atualização e exclusão
de informações.

2.2 Outros tipos de APIs: Além das APIs baseadas em

REST, existem outros tipos de APIs que podem ser
utilizadas, dependendo das necessidades e
tecnologias envolvidas:

www.marcioguinati.com
Licensed to João Miguel Gil Veiga Salgues - [email protected] - 089.751.274

CAPÍTULO 2: TIPOS DE APIS

API baseada em SOAP (Simple Object Access

Protocol): O SOAP é um protocolo de comunicação
mais complexo, que utiliza XML (Extensible Markup
Language) para estruturar os dados transmitidos. As
APIs baseadas em SOAP são frequentemente
utilizadas em ambientes corporativos e permitem a
troca de informações entre sistemas heterogêneos.

API baseada em GraphQL: O GraphQL é uma

linguagem de consulta e uma especificação para
APIs, desenvolvida pelo Facebook. Ele permite que os
clientes solicitem exatamente os dados necessários,
evitando problemas de supercarga de informações.
As APIs baseadas em GraphQL oferecem mais
flexibilidade aos desenvolvedores em relação aos
dados que desejam obter.

API baseada em WebSocket: O WebSocket é um

protocolo de comunicação bidirecional que permite
uma conexão persistente entre o cliente e o servidor.
Esse tipo de API é ideal para aplicações em tempo
real, como chats, jogos online e sistemas de
monitoramento.

www.marcioguinati.com
Licensed to João Miguel Gil Veiga Salgues - [email protected] - 089.751.274

CAPÍTULO 2: TIPOS DE APIS

Cada tipo de API tem suas características e é

adequado para diferentes situações. É importante
entender essas diferenças e escolher o tipo de API
mais adequado para o projeto em questão, levando
em consideração os requisitos técnicos e de
negócios.

www.marcioguinati.com
Licensed to João Miguel Gil Veiga Salgues - [email protected] - 089.751.274

CAPÍTULO 3: FUNDAMENTOS API

3.1 Requisições HTTP:

As APIs utilizam o protocolo HTTP (Hypertext
Transfer Protocol) como meio de comunicação
entre o cliente (aplicativo que consome a API) e
o servidor (que disponibiliza a API). No contexto
de uma API, as requisições HTTP são usadas
para solicitar ações ou informações específicas.

Existem diferentes tipos de requisições HTTP,

sendo as mais comuns:

GET: Utilizada para obter informações do

servidor. O cliente envia uma requisição GET
para uma URL específica e recebe uma resposta
contendo os dados solicitados.
POST: Utilizada para enviar dados ao servidor e
criar novos recursos. Por exemplo, ao preencher
um formulário online e enviar os dados para
serem processados e armazenados no servidor.
PUT: Utilizada para atualizar recursos existentes
no servidor. O cliente envia uma requisição PUT
com os dados atualizados para uma URL
específica.

www.marcioguinati.com
Licensed to João Miguel Gil Veiga Salgues - [email protected] - 089.751.274

CAPÍTULO 3: FUNDAMENTOS API

DELETE: Utilizada para excluir recursos do servidor. O

cliente envia uma requisição DELETE para uma URL
específica, indicando o recurso a ser removido.

3.2 Métodos HTTP comuns:

Além dos métodos mencionados acima (GET, POST,
PUT e DELETE), existem outros métodos HTTP
comumente usados em APIs, incluindo:

PATCH: Utilizada para atualizar parcialmente um

recurso no servidor. Em vez de enviar todos os dados
do recurso, a requisição PATCH envia apenas as
alterações específicas.
OPTIONS: Utilizada para obter informações sobre os
métodos suportados pela API. Permite ao cliente
saber quais ações podem ser executadas em
determinada URL.
Esses métodos HTTP fornecem uma maneira
padronizada de interagir com uma API, permitindo
que o cliente realize diferentes ações, como obter
dados, criar, atualizar ou excluir recursos.

www.marcioguinati.com
Licensed to João Miguel Gil Veiga Salgues - [email protected] - 089.751.274

CAPÍTULO 3: FUNDAMENTOS API

3.3 Formatos de dados: JSON e XML:

As APIs geralmente utilizam formatos de dados para
estruturar as informações transmitidas entre o
cliente e o servidor. Dois formatos comuns são JSON
(JavaScript Object Notation) e XML (Extensible
Markup Language).

JSON: É um formato leve, legível para humanos e de

fácil interpretação para máquinas. Ele consiste em
pares de chave-valor e é amplamente utilizado em
APIs modernas devido à sua simplicidade e
compatibilidade com várias linguagens de
programação.
XML: É uma linguagem de marcação que permite a
criação de documentos estruturados. Embora seja
mais verboso do que o JSON, ainda é usado em
algumas APIs, especialmente aquelas que foram
desenvolvidas há mais tempo.
Esses formatos de dados permitem que as
informações sejam transmitidas de forma
estruturada e compreensível para as aplicações
consumidoras da API.

www.marcioguinati.com
Licensed to João Miguel Gil Veiga Salgues - [email protected] - 089.751.274

CAPÍTULO 3: FUNDAMENTOS API

3.4 Autenticação e autorização:

Para garantir a segurança e controlar o acesso aos
recursos, as APIs podem exigir autenticação e
autorização. A autenticação verifica a identidade do
cliente que está fazendo a requisição, enquanto a
autorização verifica se o cliente possui permissões
adequadas para acessar determinado recurso.

Diferentes métodos de autenticação podem ser

usados em APIs, como tokens de acesso (Access
Tokens), chaves de API (API Keys) ou autenticação
baseada em OAuth. Esses métodos garantem que
apenas clientes autorizados possam acessar os
recursos da API.

Um método comum de autenticação em APIs é o uso

de tokens de acesso. Nesse método, um token único
é gerado para cada cliente autorizado. Esse token é
incluído nas requisições feitas pelo cliente como
prova de autenticação. O servidor API verifica a
validade do token para garantir que o cliente seja
autenticado.

www.marcioguinati.com
Licensed to João Miguel Gil Veiga Salgues - [email protected] - 089.751.274

CAPÍTULO 3: FUNDAMENTOS API

Outra abordagem é o uso de chaves de API. As

chaves de API são códigos secretos que são
fornecidos aos clientes autorizados. O cliente inclui
essa chave nas requisições para autenticar-se junto
ao servidor API. Essas chaves podem ser revogadas
ou regeneradas pelo provedor da API, permitindo um
maior controle sobre o acesso aos recursos.

A autenticação baseada em OAuth é outro método

amplamente utilizado. O OAuth é um protocolo de
autorização que permite que os usuários concedam
acesso a seus recursos em um serviço a terceiros
sem compartilhar suas credenciais de autenticação.
Por meio do OAuth, um cliente pode obter um token
de acesso válido para interagir com a API em nome
do usuário autenticado.

Após a autenticação, a autorização entra em cena

para determinar se o cliente autenticado tem
permissão para acessar um determinado recurso ou
executar uma determinada ação.

www.marcioguinati.com
Licensed to João Miguel Gil Veiga Salgues - [email protected] - 089.751.274

CAPÍTULO 3: FUNDAMENTOS API

Isso é geralmente feito por meio de regras de

autorização definidas pelo provedor da API. Essas
regras podem ser baseadas em funções, níveis de
acesso ou qualquer outro critério definido.

A autenticação e autorização são aspectos

essenciais na segurança de APIs, garantindo que
apenas usuários autenticados e autorizados tenham
acesso aos recursos protegidos. Cada provedor de
API pode escolher o método de autenticação e
autorização que melhor se adapte às suas
necessidades e aos requisitos de segurança.

www.marcioguinati.com
Licensed to João Miguel Gil Veiga Salgues - [email protected] - 089.751.274

CAPÍTULO 4: EXPLORANDO APIS

4.1 Encontrando APIs disponíveis:

Antes de começar a utilizar uma API, é importante
encontrar as opções disponíveis que atendam às
suas necessidades. Existem várias maneiras de
descobrir APIs, incluindo:

Pesquisa online: Faça pesquisas na web usando

palavras-chave relacionadas ao serviço ou
funcionalidade que você está procurando. Muitas
empresas e plataformas disponibilizam suas APIs
publicamente e fornecem documentação para
facilitar a integração.

Diretórios de APIs: Acesse diretórios especializados

em APIs, como o "ProgrammableWeb" e "RapidAPI".
Esses diretórios listam uma ampla variedade de APIs
disponíveis, facilitando a busca por serviços
específicos.

www.marcioguinati.com
Licensed to João Miguel Gil Veiga Salgues - [email protected] - 089.751.274

CAPÍTULO 4: EXPLORANDO APIS

4.2 Documentação de APIs:

Uma vez que você tenha encontrado uma API
interessante, é crucial consultar a documentação
fornecida pela empresa ou plataforma. A
documentação de uma API contém informações
detalhadas sobre como utilizar e interagir com os
recursos disponíveis. Essas informações geralmente
incluem:

Descrição geral: Uma visão geral do propósito da API,

seus recursos principais e casos de uso comuns.

Endpoints e parâmetros: Uma lista dos endpoints

disponíveis (URLs que correspondem a recursos
específicos) e os parâmetros que podem ser
incluídos nas requisições para personalizar a
solicitação.

Métodos suportados: Os métodos HTTP suportados

pela API, como GET, POST, PUT, DELETE, entre outros.

www.marcioguinati.com
Licensed to João Miguel Gil Veiga Salgues - [email protected] - 089.751.274

CAPÍTULO 4: EXPLORANDO APIS

Exemplos de requisições e respostas: Exemplos

práticos de como fazer requisições para a API e como
interpretar as respostas obtidas.

Autenticação e autorização: Informações sobre

como autenticar-se na API e obter as chaves de
acesso necessárias, além de instruções sobre
permissões e escopos de autorização.

4.3 Testando uma API com ferramentas como o

Postman:
Uma etapa importante para explorar e entender uma
API é testá-la. Existem diversas ferramentas
disponíveis para facilitar esse processo, sendo uma
delas o Postman, uma aplicação que permite enviar
requisições HTTP e visualizar as respostas.

Com o Postman, você pode criar solicitações para os

endpoints da API, configurar os cabeçalhos, adicionar
parâmetros e dados necessários, e analisar as
respostas retornadas.

www.marcioguinati.com
Licensed to João Miguel Gil Veiga Salgues - [email protected] - 089.751.274

CAPÍTULO 4: EXPLORANDO APIS

Essa abordagem prática permite que você

experimente diferentes funcionalidades da API,
compreenda melhor seus recursos e garanta que
esteja fazendo as requisições corretamente.

Ao testar uma API, é recomendado começar com

solicitações básicas e, gradualmente, explorar casos
mais complexos, a fim de se familiarizar com todas as
funcionalidades oferecidas.

Explorar e entender uma API por meio de sua

documentação e ferramentas de teste é essencial
para garantir uma integração bem-sucedida e
aproveitar ao máximo os recursos disponíveis.

www.marcioguinati.com
Licensed to João Miguel Gil Veiga Salgues - [email protected] - 089.751.274

CAPÍTULO 5: DOCUMENTAÇÃO APIS

5.1 Importância da documentação:

A documentação de uma API é uma peça
fundamental para os desenvolvedores que desejam
utilizá-la de forma eficiente. Ela fornece informações
detalhadas sobre como interagir com a API, quais
recursos estão disponíveis e como utilizar cada um
deles. A documentação bem elaborada e abrangente
é essencial para garantir que os desenvolvedores
possam entender, integrar e utilizar a API
corretamente.

5.2 Componentes da documentação de APIs:

Uma boa documentação de API deve abordar
diversos aspectos e fornecer informações claras e
organizadas. Aqui estão alguns dos principais
componentes que podem estar presentes na
documentação de uma API:

www.marcioguinati.com
Licensed to João Miguel Gil Veiga Salgues - [email protected] - 089.751.274

CAPÍTULO 5: DOCUMENTAÇÃO APIS

Visão geral da API: Uma descrição geral do

propósito da API, suas principais funcionalidades
e casos de uso comuns. Isso ajuda os
desenvolvedores a entenderem rapidamente o
que a API oferece e como ela pode ser aplicada.

Endpoints e parâmetros: Uma lista detalhada de

todos os endpoints disponíveis na API,
juntamente com os parâmetros e valores
esperados em cada solicitação. Isso inclui
informações sobre os tipos de dados aceitos, a
estrutura dos objetos e qualquer validação
adicional necessária.

Métodos HTTP suportados: Uma lista dos

métodos HTTP suportados pela API, como GET,
POST, PUT e DELETE, juntamente com suas
finalidades e exemplos de uso.

Exemplos de requisições e respostas: Exemplos

práticos de como fazer requisições para a API,
mostrando as estruturas de solicitação corretas e
os formatos de resposta esperados.

www.marcioguinati.com
Licensed to João Miguel Gil Veiga Salgues - [email protected] - 089.751.274

CAPÍTULO 5: DOCUMENTAÇÃO APIS

Esses exemplos ajudam os desenvolvedores a

entender a sintaxe e a estrutura de dados utilizada na
API.

Autenticação e autorização: Informações detalhadas

sobre como autenticar-se na API, obter chaves de
acesso (API keys) ou tokens de autenticação, e como
usar esses mecanismos para autorizar o acesso a
recursos específicos.

Limites e cotas: Se a API impuser limites ou cotas de

uso, é importante que essas restrições sejam
documentadas de forma clara. Isso inclui
informações sobre taxas de requisições, limites de
solicitações por período de tempo e outras políticas
de uso.

Erros e códigos de status: Uma lista dos possíveis

códigos de status HTTP que a API pode retornar em
diferentes situações, juntamente com descrições
claras de cada código e como lidar com os erros
correspondentes.

www.marcioguinati.com
Licensed to João Miguel Gil Veiga Salgues - [email protected] - 089.751.274

CAPÍTULO 5: DOCUMENTAÇÃO APIS

Exemplos de código: Amostras de código em

diferentes linguagens de programação que
demonstram como fazer solicitações à API e
processar as respostas.

Esses exemplos ajudam os desenvolvedores a

começar rapidamente e a entender como integrar a
API em seus próprios projetos.

5.3 Manutenção e atualização da documentação:

A documentação de uma API não deve ser estática. À
medida que a API evolui, novos recursos são
adicionados ou alterados, e a documentação precisa
ser atualizada para refletir essas mudanças. Além
disso, é importante fornecer canais de suporte,
como fóruns ou e-mails de contato, para que os
desenvolvedores possam obter ajuda e esclarecer
dúvidas

www.marcioguinati.com
Licensed to João Miguel Gil Veiga Salgues - [email protected] - 089.751.274

CAPÍTULO 6: BOAS PRÁTICAS NO

USO DE APIS

Versionamento da API para garantir a

compatibilidade entre diferentes versões.
Uso adequado de autenticação e autorização
para proteger a API e controlar o acesso aos
recursos.
Implementação de um gerenciamento de erros
adequado, fornecendo mensagens claras e
tratando os erros corretamente.
Utilização de cache para melhorar o desempenho
e reduzir a carga no servidor.
Monitoramento e análise do desempenho da API
para identificar problemas e realizar melhorias.
Documentação clara e abrangente, incluindo
exemplos de código e informações detalhadas
sobre os recursos disponíveis.
Lidar com limites de taxa e cotas impostos pela
API, implementando mecanismos adequados de
controle.
Tratamento de erros e feedbacks úteis para os
usuários, facilitando a correção de problemas.
Manutenção e atualização contínua,
acompanhando as atualizações e versões mais
recentes da API.

www.marcioguinati.com
Licensed to João Miguel Gil Veiga Salgues - [email protected] - 089.751.274

CAPÍTULO 6: BOAS PRÁTICAS NO

USO DE APIS

Seguir essas boas práticas ajudará a garantir uma

integração bem-sucedida, desempenho otimizado
e segurança adequada ao utilizar APIs.

QUESTIONÁRIO SOBRE API

RESPONDER

www.marcioguinati.com
Licensed to João Miguel Gil Veiga Salgues - [email protected] - 089.751.274

CAPÍTULO 7: MÃO NA MASSA

Neste capítulo, vamos colocar a mão na massa e

realizar a integração com a API do ViaCEP

7.1 Integrando com a API do VIACEP:

Site: https://viacep.com.br/
Localizar Formato de Retorno JSON

Agora, iremos entrar no POSTMAN

Ao menu lateral esquerdo, está escrito Collection
e ao lado direito tem um sinal de +, clicar no
mesmo

www.marcioguinati.com
Licensed to João Miguel Gil Veiga Salgues - [email protected] - 089.751.274

CAPÍTULO 7: MÃO NA MASSA

Preencher o nome da Collection e apertar CTRL +

S para salvar

www.marcioguinati.com
Licensed to João Miguel Gil Veiga Salgues - [email protected] - 089.751.274

CAPÍTULO 7: MÃO NA MASSA

Após ter criado a Collection, iremos clicar no sinal

de "+" ao lado do nome que acabamos de criar, no
meu caso chamado "API via CEP"

Agora, iremos inserir o ENDPOINT abaixo onde

está escrito "Enter URL or paste text" e selecionar
o método GET, pois faremos uma busca.
URL: viacep.com.br/ws/01001000/json/

www.marcioguinati.com
Licensed to João Miguel Gil Veiga Salgues - [email protected] - 089.751.274

CAPÍTULO 7: MÃO NA MASSA

Agora, com a URL preenchida, iremos clicar na

opção "SEND" para realizar a pesquisa.

Podemos observar logo abaixo, no corpo (BODY),

as informações.

www.marcioguinati.com
Licensed to João Miguel Gil Veiga Salgues - [email protected] - 089.751.274

CAPÍTULO 7: MÃO NA MASSA

Caso queira alterar o CEP, basta substituir o CEP

que está na URL, no caso 01001000, pelo seu
próprio CEP.

www.marcioguinati.com
Licensed to João Miguel Gil Veiga Salgues - [email protected] - 089.751.274

CAPÍTULO 7: MÃO NA MASSA

Neste capítulo, iremos criar uma API utilizando o

JSON Server e as ferramentas listadas abaixo:
Visual Studio Code
https://code.visualstudio.com/
Node.js
https://nodejs.org/en
Postman
https://www.postman.com/

Para facilitar o entendimento, abaixo você

encontrará um vídeo de treinamento.

CRIANDO UMA API E FAZENDO

REQUISIÇÕES

VISUALIZAR

www.marcioguinati.com
Licensed to João Miguel Gil Veiga Salgues - [email protected] - 089.751.274

AGRADECIMENTOS

Caro leitor,

Gostaríamos de expressar nossa sincera gratidão

pelo tempo que você dedicou à leitura do nosso
eBook sobre APIs. Estamos felizes em saber que
nosso material está sendo útil e fornecendo o
conhecimento necessário para entender melhor
esse assunto.

Nosso objetivo ao criar esse eBook era oferecer um

guia claro e acessível para pessoas iniciantes, como
você, que desejam aprender sobre APIs. É
gratificante saber que estamos cumprindo esse
objetivo e contribuindo para o seu aprendizado.
Se você tiver alguma dúvida ou precisar de mais
informações, não hesite em entrar em contato
conosco. Estamos aqui para ajudar e fornecer todo o
suporte necessário.
E-mail suporte: [email protected]

Mais uma vez, agradecemos por dedicar seu tempo e

confiar em nosso material. Desejamos a você muito
sucesso em sua jornada de aprendizado sobre APIs!
Atenciosamente, Marcio Guinati

www.marcioguinati.com
Licensed to João Miguel Gil Veiga Salgues - [email protected] - 089.751.274

OBRIGADO POR
COMPRAR MEU
EBOOK

www.marcioguinati.com