Voltar

    Documentação da API

    API REST pública para gerenciar links de rastreamento programaticamente.

    Autenticação

    Todas as requisições devem incluir o header X-API-Key com sua chave de API. Gere uma chave no seu Dashboard, na seção "API".

    curl https://xmgdeqnjhzvarfyjbleg.supabase.co/functions/v1/api-v1/links \
      -H "X-API-Key: lk_sua_chave_aqui"

    URL Base

    https://xmgdeqnjhzvarfyjbleg.supabase.co/functions/v1/api-v1

    Formato de Resposta

    Todas as respostas seguem o formato padrão:

    {
      "data": { ... },
      "error": null,
      "meta": {
        "page": 1,
        "per_page": 20,
        "total": 42
      }
    }

    Endpoints

    GET
    /links

    Lista todos os seus links de rastreamento. Suporta paginação com ?page=1&per_page=20

    curl
    curl "https://xmgdeqnjhzvarfyjbleg.supabase.co/functions/v1/api-v1/links?page=1&per_page=10" \
      -H "X-API-Key: lk_sua_chave"
    GET
    /links/:id

    Retorna os detalhes de um link específico.

    curl
    curl "https://xmgdeqnjhzvarfyjbleg.supabase.co/functions/v1/api-v1/links/uuid-do-link" \
      -H "X-API-Key: lk_sua_chave"
    POST
    /links

    Cria um novo link de rastreamento. Campos obrigatórios: title, destination_url.

    curl
    curl -X POST "https://xmgdeqnjhzvarfyjbleg.supabase.co/functions/v1/api-v1/links" \
      -H "X-API-Key: lk_sua_chave" \
      -H "Content-Type: application/json" \
      -d '{
        "title": "Meu Link",
        "destination_url": "https://exemplo.com",
        "capture_gps": true,
        "capture_camera": false
      }'
    PUT
    /links/:id

    Atualiza um link existente. Envie apenas os campos que deseja alterar.

    curl
    curl -X PUT "https://xmgdeqnjhzvarfyjbleg.supabase.co/functions/v1/api-v1/links/uuid-do-link" \
      -H "X-API-Key: lk_sua_chave" \
      -H "Content-Type: application/json" \
      -d '{ "title": "Novo Título" }'
    DELETE
    /links/:id

    Exclui um link de rastreamento.

    curl
    curl -X DELETE "https://xmgdeqnjhzvarfyjbleg.supabase.co/functions/v1/api-v1/links/uuid-do-link" \
      -H "X-API-Key: lk_sua_chave"
    GET
    /links/:id/clicks

    Lista os cliques capturados de um link. Suporta paginação.

    curl
    curl "https://xmgdeqnjhzvarfyjbleg.supabase.co/functions/v1/api-v1/links/uuid-do-link/clicks?page=1" \
      -H "X-API-Key: lk_sua_chave"

    Códigos de Erro

    CódigoDescrição
    400Dados inválidos na requisição
    401Chave de API ausente ou inválida
    404Recurso não encontrado
    405Método HTTP não permitido
    429Rate limit excedido (100 req/min)
    500Erro interno do servidor

    Limites

    Rate limit: 100 requisições por minuto por IP

    Paginação: Máximo de 100 itens por página

    Autenticação: Cada chave de API está vinculada ao seu usuário