Pierre Mendes Salatiel

Posted on May 15

🧙‍♂️ O Guia Mestre de APIs: Como ser o Bruxo do multiverso

#api #json #security #http

E aí, dev! Já sentiu que o mundo das APIs parece um multiverso confuso? Calma, não precisa chamar o Doutor Estranho. Neste artigo, vamos sair do absoluto zero e virar um verdadeiro arquiteto da Matrix.

1. O que raios é uma API? 🍔

Imagine que você está no filme Ratatouille.

Você (O Cliente): Está na mesa e quer um prato.
A Cozinha (O Servidor): Onde o Remy faz a mágica acontecer.
O Garçom (A API): Você não vai até a cozinha gritar com o rato. Você fala com o garçom. Ele leva seu pedido, traduz para a cozinha e traz o prato pronto.

API significa Application Programming Interface. É o contrato de etiqueta que permite que o seu código PHP converse com o mundo.

✉️ Anatomia de uma Requisição (O Envelope Digital)

Para a "conversa" acontecer, enviamos uma Request (Pedido) e recebemos uma Response (Resposta). Pense nisso como uma carta:

A URL (O Endereço): Para onde a carta está indo.
Headers (O Envelope): Aqui vão as informações de "bastidores". Quem está enviando? Qual o formato do papel? Tem selo de segurança (Token)? Ex: Content-Type: application/json avisa que o que está dentro é um JSON.
Body (A Carta): É o conteúdo real. Se você está cadastrando um usuário, os dados dele (nome, senha) vão aqui. Importante: Requisições do tipo GET geralmente não têm Body, elas levam tudo na URL!

Os Verbos HTTP (Suas intenções):

GET: "Me mostra os planos da Estrela da Morte" (Apenas leitura).
POST: "Cadastrar um novo Vingador" (Criar algo).
PUT: "Trocar a armadura inteira do Homem de Ferro" (Substituir tudo).
PATCH: "Consertar apenas o escudo do Capitão América" (Mudar um pedaço).
DELETE: "Thanos deu um estalo" (Apagar algo).

Status Codes HTTP

Os famosos códigos HTTP.

200 OK
Tudo deu certo.

201 Created
Algo foi criado.

400 Bad Request
A requisição veio errada.

401 Unauthorized
Usuário não autenticado.

403 Forbidden
Usuário autenticado, mas sem permissão.

404 Not Found
Recurso não encontrado.

500 Internal Server Error
Erro interno no servidor.

2. Formatos de Dados: O Idioma Universal 📜

Para que o PHP entenda o que um App Android enviou, precisamos de um idioma comum.

💎 JSON (O Queridinho)

Leve e simples. Parece um dicionário ou um objeto do JavaScript.

{
  "heroi": "Batman",
  "identidade": "Bruce Wayne",
  "gadgets": ["Batarang", "Batmobile"]
}

📜 XML (O Ancião)

Baseado em tags, como o HTML. É mais "verboso" (pesado), mas muito usado em sistemas do governo e bancos.

<personagem>
    <nome>Batman</nome>
    <identidade>Bruce Wayne</identidade>
    <gadget>Batarang</gadget>
</personagem>

3. Padrões de APIs: Escolha seu Estilo de Luta 🥋

REST: O clássico. Foca em Recursos. URLs intuitivas como /produtos.
GraphQL: O "Self-Service". Você pede exatamente as colunas que quer e evita carregar dados inúteis.
SOAP: O padrão "Corporativo Sério". Usa apenas XML e é extremamente rígido e seguro (como um contrato autenticado em cartório).
gRPC: O "Flash". Criado pelo Google, usa dados binários. É tão rápido que parece teletransporte, usado para servidores conversarem entre si.

4. Classificando o Multiverso das APIs 🌌

Pela Tecnologia:

API Web: Acessadas via internet.
API Hardware: O PHP acessando a câmera ou um sensor de temperatura.
API de Plataforma: Como o Graph API do Facebook.

Pelas Políticas de Uso:

Públicas (Open): Porta aberta! (Ex: API do Pokémon).
Privadas (Internas): Só os funcionários da empresa acessam.
De Parceiros: Compartilhada entre empresas parceiras.
Compostas: Uma API que chama várias outras para te dar um "resumão".

5. Segurança: A Arca da Aliança 🔐

API Keys: Uma chave simples no Header. Fácil, mas se vazar, já era.
JWT (JSON Web Tokens): O "Crachá VIP". Após o login, você ganha uma string criptografada que prova quem você é.
OAuth2: O botão "Logar com Google". Você autoriza um app a acessar seus dados sem dar sua senha para ele.

5. O Laboratório do Dexter: Postman 🧪

O Postman é essencial para testar seus poderes.

Crie uma Request: Clique no "+".
Verbo e URL: Escolha GET e cole https://pokeapi.co/api/v2/pokemon/pikachu
Send: Clique no botão azul.

🏁 Conclusão

Parabéns! Você agora entende que APIs são conversas estruturadas. Você sabe o que vai no envelope (Headers), o que vai na carta (Body) e como interpretar todas essas conversas no seu dia a dia.

DEV Community