Exemplos de Requisições com CURL

Este documento contém exemplos de como testar a API Flowbiz usando CURL, uma ferramenta de linha de comando para transferência de dados com sintaxe URL.

Requisitos

Para executar estes exemplos, você precisará ter o CURL instalado em seu sistema. O CURL está disponível para praticamente todos os sistemas operacionais:

Linux: Geralmente já vem instalado. Caso contrário, use sudo apt-get install curl (Debian/Ubuntu) ou sudo yum install curl (CentOS/RHEL)
macOS: Geralmente já vem instalado
Windows: Baixe do site oficial ou instale via Chocolatey com choco install curl

Exemplos de Requisições

Substitua seu-dominio.com pelo domínio real onde sua API está hospedada e sua_api_key_aqui pela sua chave de API real.

Health check

curl -X GET "https://seu-dominio.com/api/v2/healthz"

Listar Categorias

curl -X GET "http://seu-dominio.com/api/v2/categories?offset=0&limit=100" \
     -H "X-Impulse-Key: sua_api_key_aqui" \
  -H "Accept: application/json"

Listar Marcas

curl -X GET "http://seu-dominio.com/api/v2/brands?offset=0&limit=100" \
     -H "X-Impulse-Key: sua_api_key_aqui" \
  -H "Accept: application/json"

Listar Produtos

curl -X GET "http://seu-dominio.com/api/v2/products?offset=0&limit=100" \
     -H "X-Impulse-Key: sua_api_key_aqui" \
  -H "Accept: application/json"

Listar Pedidos

curl -X GET "https://seu-dominio.com/api/v2/orders?offset=0&limit=50&start_date=2023-01-01&end_date=2023-01-31" \
  -H "X-Impulse-Key: sua_api_key_aqui" \
  -H "Accept: application/json"

Paginação (página 2) com filtro de data

curl -X GET "https://seu-dominio.com/api/v2/orders?offset=50&limit=50&start_date=2023-01-01&end_date=2023-01-31" \
  -H "X-Impulse-Key: sua_api_key_aqui" \
  -H "Accept: application/json"

Exemplos com Formatação de Saída

Para uma saída mais legível, você pode usar o utilitário jq para formatar o JSON retornado:

curl -X GET "https://seu-dominio.com/api/v2/categories?offset=0&limit=50" \
  -H "X-Impulse-Key: sua_api_key_aqui" \
  -H "Accept: application/json" | jq

Se você não tiver o jq instalado, pode instalá-lo:

Linux: sudo apt-get install jq (Debian/Ubuntu) ou sudo yum install jq (CentOS/RHEL)
macOS: brew install jq (usando Homebrew)
Windows: choco install jq (usando Chocolatey)

Exemplos com Redirecionamento para Arquivo

Para salvar a resposta em um arquivo:

curl -X GET "https://seu-dominio.com/api/v2/orders?offset=0&limit=50&start_date=2023-01-01&end_date=2023-01-31" \
  -H "X-Impulse-Key: sua_api_key_aqui" \
  -H "Accept: application/json" > orders.json

Exemplos com Verbosidade

Para ver detalhes completos da requisição e resposta, incluindo cabeçalhos:

curl -v -X GET "https://seu-dominio.com/api/v2/categories?offset=0&limit=50" \
  -H "X-Impulse-Key: sua_api_key_aqui" \
  -H "Accept: application/json"

Exemplos com Verificação de Status HTTP

Para ver apenas o código de status HTTP:

curl -s -o /dev/null -w "%{http_code}" -X GET "https://seu-dominio.com/api/v2/categories" \
  -H "X-Impulse-Key: sua_api_key_aqui" \
  -H "Accept: application/json"

Script de Teste Completo

Aqui está um script Bash completo para testar todos os endpoints:

#!/bin/bash

# Configuração
API_URL="https://seu-dominio.com/api/v2"
API_KEY="sua_api_key_aqui"

header() {
  echo "X-Impulse-Key: $API_KEY"
}

make_request() {
  local endpoint=$1
  local params=$2

  echo "Testando endpoint: $endpoint?$params"
  curl -s -X GET "$API_URL/$endpoint?$params" \
    -H "$(header)" \
    -H "Accept: application/json" | jq
  echo -e "\n-----------------------------------\n"
}

echo "Iniciando testes da API..."

echo "0. Healthz"
curl -s "$API_URL/healthz" && echo -e "\n-----------------------------------\n"

echo "1. Categorias"
make_request "categories" "offset=0&limit=50"

echo "2. Marcas"
make_request "brands" "offset=0&limit=50"

echo "3. Produtos"
make_request "products" "offset=0&limit=50"

echo "4. Pedidos (com filtro de data)"
make_request "orders" "offset=0&limit=50&start_date=2023-01-01&end_date=2023-01-31"

echo "5. Pedidos (página 2)"
make_request "orders" "offset=50&limit=50&start_date=2023-01-01&end_date=2023-01-31"

echo "Testes concluídos!"

Para usar este script:

Salve-o em um arquivo (por exemplo, test_flowbiz_api.sh)
Torne-o executável: chmod +x test_flowbiz_api.sh
Execute-o: ./test_flowbiz_api.sh

Dicas para Solução de Problemas

Erro 401 (Unauthorized): Verifique se a API Key está correta
Erro 404 (Not Found): Verifique se a URL do endpoint está correta
Erro de conexão: Verifique se o servidor está acessível e se não há problemas de rede
Resposta vazia: Verifique se há dados disponíveis para os parâmetros fornecidos

Para mais informações sobre o CURL, consulte a documentação oficial.