Zaia Docs
APIZaia AcademyComunidade no Discord
API
API
  • Introdução
    • Fundamentos APIS
      • 1.O que é um JSON e sua importância
      • 2.O Que é um Webhook?
      • 3.O Que é cURL?
      • 4.O Que é uma API?
  • Chat Generativo Externo
    • [GET] Buscar chat
    • [GET] Buscar múltiplos chats
    • [POST] Criar novo chat
  • Mensagem Generativa Externa
    • [PATCH] Resolve Takeover
    • [POST] Create
    • [GET] Retrieve Multiple
  • Mensagem entre canais
    • [POST] Envio de textos, áudios e imagens externas
  • Agente
    • [POST] Criar agente
    • [PATCH] Atualizar agente
    • [DELETE] Excluir agente
    • [GET] Buscar agentes
  • Variáveis
    • [PATCH] Atualizar variáveis
  • Estágios do Agente
    • [POST] Criar um estágio
    • [PATCH] Reorganizar estágios
    • [DELETE] Remover estágio
    • [GET] Listar estágios
    • [PATCH] Atualizar
  • Follow Up
    • [POST] Cancelar Follow Ups
  • Requisições HTTP de Estágio de Chat
    • [DELETE] Remover
    • [GET] Recuperar Múltiplos
    • [GET] Recuperar
    • [PATCH] Atualizar
  • Cérebro
    • [POST] Criar Crawler
    • [DELETE] Remover Crawler
    • [DELETE] Remover Múltiplos Crawlers
    • [POST] Treinar Crawler
    • [GET] Recuperar Múltiplos Crawlers
    • [POST] Treinar Arquivo
    • [DELETE] Remover Arquivo
    • [DELETE] Remover Múltiplos Arquivos
    • [GET] Recuperar Múltiplos Arquivos
  • Mensagem Generativa Efêmera
  • Consumo
Fornecido por GitBook
Nesta página
  • 📖 Analogia: Tomada Elétrica
  • 🛠️ O Que São Rotas e Métodos HTTP?
  • 📌 Os Principais Métodos HTTP
  • 🟣 Exemplo Prático dos Métodos HTTP
  • 🚀 Agora Você Está Pronto Para Usar a API da Zaia!
  1. Introdução
  2. Fundamentos APIS

4.O Que é uma API?

API (Application Programming Interface) é um conjunto de regras que permite que diferentes sistemas conversem entre si.

📖 Analogia: Tomada Elétrica

Uma API funciona como uma tomada elétrica. Se você tem um carregador de celular, ele pode ser conectado a qualquer tomada porque todas seguem o mesmo padrão.

Da mesma forma, uma API permite que diferentes programas se conectem e troquem informações.

Exemplo de API:

1. Você usa um aplicativo de clima no celular.

2. O aplicativo se conecta à API de previsão do tempo.

3. A API responde com a temperatura e previsão do dia.

Uma API pode ser acessada com um simples comando cURL:

curl -X GET "https://api.clima.com/hoje"

E a resposta pode ser algo assim:

{
  "cidade": "Rio de Janeiro",
  "temperatura": 28,
  "condicao": "Ensolarado"
}

Isso mostra que a API retorna informações úteis para serem usadas por outros sistemas.

🛠️ O Que São Rotas e Métodos HTTP?

Uma rota de API é um caminho específico que permite acessar um recurso dentro de um servidor.

🔍 Analogia: Endereços de Casas

Pense nas rotas da API como endereços de casas:

• "https://api.meusite.com/usuarios" → Endereço onde estão os usuários.

• "https://api.meusite.com/produtos" → Endereço onde estão os produtos.

• "https://api.meusite.com/pedidos" → Endereço onde estão os pedidos.

Cada rota leva a um dado ou funcionalidade diferente dentro da API.

📌 Os Principais Métodos HTTP

Os métodos HTTP são como ações que podemos realizar nas rotas da API.

Método
O que faz?
Exemplo de Uso

GET

Busca dados

Ver uma lista de produtos

POST

Cria um novo dado

Criar um novo usuário

PUT

Atualiza um dado inteiro

Alterar todo um pedido

PATCH

Atualiza um pedaço do dado

Mudar apenas o status do pedido

DELETE

Remove um dado

Excluir um usuário

🟣 Exemplo Prático dos Métodos HTTP

Imagine que temos uma API para gerenciar usuários.

1️⃣ Buscar todos os usuários (GET)
curl -X GET "https://api.meusite.com/usuarios"

Aqui estamos pedindo para ver a lista de usuários cadastrados.

2️⃣ Criar um novo usuário (POST)
curl -X POST "https://api.meusite.com/usuarios" \
     -H "Content-Type: application/json" \
     -d '{
          "nome": "Maria",
          "email": "maria@email.com"
         }'

Criamos um novo usuário chamado Maria.

3️⃣ Atualizar um usuário (PUT - Substituir todos os dados)
curl -X PUT "https://api.meusite.com/usuarios/1" \
     -H "Content-Type: application/json" \
     -d '{
          "nome": "Maria Silva",
          "email": "maria.silva@email.com"
         }'

Aqui estamos substituindo todos os dados do usuário ID 1.

4️⃣ Alterar apenas o e-mail do usuário (PATCH - Atualizar parte do dado)
curl -X PATCH "https://api.meusite.com/usuarios/1" \
     -H "Content-Type: application/json" \
     -d '{
          "email": "maria.novo@email.com"
         }'

Atualizamos somente o e-mail do usuário ID 1, sem mexer no nome.

5️⃣ Excluir um usuário (DELETE)
curl -X DELETE "https://api.meusite.com/usuarios/1"

📌 Removemos o usuário com ID 1 usando a API.

Agora você sabe:

  • O que são rotas e como cada uma tem um propósito específico.

  • O que cada método HTTP faz e quando usá-lo.

  • Como usar cURL para fazer requisições com os métodos GET, POST, PUT, PATCH e DELETE.

Esses conceitos são essenciais para usar qualquer API, incluindo a API da Zaia, que permite criar agentes de IA no-code e automatizar interações com outros sistemas.

🚀 Agora Você Está Pronto Para Usar a API da Zaia!

Agora que você conhece os fundamentos de JSON, Webhooks, cURL e APIs, você está pronto para explorar a API da Zaia. Com esse conhecimento, você será capaz de:

✅ Ler e interpretar respostas em JSON de forma eficiente.

✅ Configurar Webhooks para receber notificações automáticas.

✅ Usar cURL para testar chamadas e interagir com APIs.

✅ Entender como diferentes sistemas se comunicam através de APIs.

A API da Zaia foi criada para facilitar automações de processos e a criação de agentes de IA no-code, permitindo integrações poderosas com diversos sistemas. Agora, é hora de começar a explorar suas funcionalidades e criar soluções incríveis!

Bem-vindo ao mundo das APIs da Zaia! 🚀 Só bora!!

Anterior3.O Que é cURL?PróximoChat Generativo Externo

Atualizado há 2 meses