Scribd
Carregar
56 visualizações7 páginas

Conceitos Fundamentais Sobre APIs

Enviado por

Alferino Filho
Direitos autorais
© © All Rights Reserved
Levamos muito a sério os direitos de conteúdo. Se você suspeita que este conteúdo é seu, reivindique-o aqui.
Formatos disponíveis
Baixe no formato PDF, TXT ou leia on-line no Scribd
56 visualizações7 páginas

Conceitos Fundamentais Sobre APIs

Enviado por

Alferino Filho
Direitos autorais
© © All Rights Reserved
Levamos muito a sério os direitos de conteúdo. Se você suspeita que este conteúdo é seu, reivindique-o aqui.
Formatos disponíveis
Baixe no formato PDF, TXT ou leia on-line no Scribd
Você está na página 1/ 7

GUIA BÁSICO

CONCEITOS
FUNDAMENTAIS
SOBRE
APIs
Definindo // 01
uma API

APIs são como pontes


que permitem que
diferentes softwares se
comuniquem.

Uma analogia comum é a do restaurante.

Pense nos dados como a comida de um restaurante.


Eles estão na cozinha e você quer consumi-los, mas
não tem permissão para acessar a cozinha
diretamente.

Você precisa de um intermediário.

O garçom, nesse caso, tem a mesma função da API:


ligar você ao que está em outro lugar.
Funcionamento // 02
de uma API

As APIs funcionam com


base em dois elementos
principais:

| Requests
| Responses

De maneira bem básica, a interação acontece da


seguinte maneira:

Solicitação: Você envia uma “mensagem” para a


API solicitando algo.

Processamento: A API interpreta o pedido e


interage com o sistema apropriado.

Resposta: A API retorna os dados ou confirma a


ação solicitada.
Principais // 03
componentes

Os principais componentes de uma API são:

Endpoint
É o endereço onde a API pode ser acessada.

Exemplo: “https://api.exemplo.com/usuarios”

Método
Ações que podem ser realizadas.

GET: Obter dados.


POST: Enviar dados para criação.
PUT: Atualizar dados existentes.
DELETE: Remover dados.

Parâmetro
Dados adicionais enviados na solicitação para especificar
o que você quer.

Exemplo: “?id=123" para obter o usuário com ID 123.

Header
Informações sobre a solicitação, como tipo de conteúdo
ou autenticação.
Consultando dados // 04
na prática

Um exemplo de aplicação prática com Python:

Passo 1: Encontrar a documentação da API.


Passo 2: Fazer uma solicitação.

Você pode usar a biblioteca requests no python,


conforme o exemplo abaixo:

Python

import requests

resp = requests.get('https://api.exemplo.com/usuarios')
data = resp.json() # Se o formato recebido for JSON

print (data)

Depois de executar o código acima, o python deve


exibir o conteúdo da solicitação.

Passo 3: Processar os dados recebidos.


Boas práticas no // 05
uso de APIs

Existem diversas boas práticas que você pode


usar quando está consumindo. Seguem abaixo
algumas:

-- Você pode checar o status da requisição para


garantir que deu tudo certo antes de processar os
dados. Alguns são:

200: Sucesso.
404: Não encontrado.
500: Erro no servidor.

-- Tenha cuidado ao armazenar informações de


autenticação (token, chave, credenciais..)

-- Verifique se a API possui algum limite de uso,


como limite de requisições por minuto, por
exemplo.
Mas calma, esse é só o
básico.

O uso e melhores práticas ao consumir


dados de uma API vai bem longe e possui
diversas abordagens.

Agora, me diz: esses conceitos foram


úteis para você?

Você também pode gostar

pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy