Encurtador de URL | URL Shortener

Documentação da API

Nossa API REST permite que você crie e gerencie URLs curtas programaticamente. Perfeito para desenvolvedores que querem integrar o encurtamento de URLs em suas aplicações.

Nota Importante

O acesso à API está disponível apenas para usuários pagos. Usuários gratuitos ainda podem usar nossa interface web para criar URLs curtas.

Free API Access

What's Available for Free

✓ Basic URL Shortening

Create short URLs through our web interface

✓ Link Statistics

View detailed analytics for your links

✓ Dashboard Access

Manage all your links in one place

✓ Mobile Responsive

Use on any device with full functionality

Paid Features

🔑 API Access

Programmatic URL shortening with API keys

📊 Advanced Analytics

Detailed API usage statistics and reports

⚡ Higher Rate Limits

Increased API request limits for high-volume usage

🎯 Custom Domains

Use your own domain for shortened URLs

Autenticação

Todas as requisições da API requerem autenticação usando uma chave de API. Você pode gerar chaves de API no seu dashboard.

Cabeçalho da Chave de API

x-api-key: sk_your_api_key_here

Exemplo de Requisição

curl -X POST https://urlme.fyi/api/v1/shorten \
  -H "Content-Type: application/json" \
  -H "x-api-key: sk_your_api_key_here" \
  -d '{"url": "https://example.com"}'

Endpoints da API

API Versioning

This documentation covers the v1 API endpoints. All endpoints are prefixed with /api/v1/.

Base URL

All API endpoints are relative to: https://urlme.fyi

Note: Replace urlme.fyi with your actual domain when using the API.

POST/api/v1/shorten

Criar URL Curta

Crie uma nova URL curta a partir de uma URL longa.

Corpo da Requisição

{
  "url": "https://example.com",
  "title": "Optional title"
}

Resposta

{
  "success": true,
  "data": {
    "id": 123,
    "slug": "abc123",
    "long_url": "https://example.com",
    "short_url": "https://urlme.fyi/abc123",
    "title": "Optional title",
    "created_at": "2024-01-01T00:00:00Z"
  }
}

GET/api/v1/shorten/[slug]

Obter Informações do Link

Recupere informações sobre uma URL curta existente.

Parâmetros da Query

[slug] - O slug da URL curta para recuperar informações

Resposta

{
  "success": true,
  "data": {
    "id": 123,
    "slug": "abc123",
    "long_url": "https://example.com",
    "short_url": "https://urlme.fyi/abc123",
    "title": "Optional title",
    "created_at": "2024-01-01T00:00:00Z"
  }
}

GET/api/v1/shorten

Get All Links

Retrieve all shortened URLs for the authenticated user.

Request

No parameters required

Requires x-api-key header

Response

{
  "success": true,
  "data": {
    "links": [
      {
        "id": 123,
        "slug": "abc123",
        "long_url": "https://example.com",
        "short_url": "https://urlme.fyi/abc123",
        "title": "Optional title",
        "created_at": "2024-01-01T00:00:00Z"
      }
    ],
    "total": 1
  }
}

Tratamento de Erros

A API usa códigos de status HTTP padrão para indicar sucesso ou falha das requisições.

401 - Não Autorizado

A chave de API está ausente, é inválida ou inativa.

{
  "error": "API key is required"
}

400 - Requisição Inválida

A requisição está malformada ou faltam parâmetros obrigatórios.

{
  "error": "URL is required"
}

404 - Não Encontrado

O recurso solicitado não foi encontrado.

{
  "error": "Link not found"
}

Limites de Taxa

Para garantir uso justo e estabilidade do sistema, as requisições da API estão sujeitas a limites de taxa.

Aviso sobre Limites de Taxa

Os limites de taxa atualmente são generosos, mas podem ser ajustados com base nos padrões de uso. Notificaremos os usuários sobre quaisquer mudanças.

Começando

1. Obtenha Sua Chave de API

Primeiro, você precisa fazer upgrade para um plano pago e gerar uma chave de API no seu dashboard.

Ir para o Dashboard

2. Faça Sua Primeira Requisição

Use sua chave de API para criar sua primeira URL curta.

# Create a shortened URL
curl -X POST https://urlme.fyi/api/v1/shorten \
  -H "Content-Type: application/json" \
  -H "x-api-key: sk_your_api_key_here" \
  -d '{"url": "https://example.com"}'

# Get all your links
curl -X GET https://urlme.fyi/api/v1/shorten \
  -H "x-api-key: sk_your_api_key_here"

# Get specific link info
curl -X GET https://urlme.fyi/api/v1/shorten/abc123 \
  -H "x-api-key: sk_your_api_key_here"

3. Comece a Desenvolver

Integre a API em suas aplicações e comece a criar URLs curtas programaticamente.

Suporte e Recursos

Precisa de ajuda com a API? Aqui estão alguns recursos para começar.

Gerenciamento do Dashboard

Gerencie suas chaves de API e visualize estatísticas de uso no seu dashboard.

Ir para o Dashboard

Ferramenta de Teste da API

Teste os endpoints da API com nossa ferramenta de teste interativa.

Abrir Ferramenta de Teste