API de Encurtamento de Links do Linkly

Crie, atualize e gerencie links programaticamente usando a API de Encurtamento de Links do Linkly.

Relacionado: API de Análise | Webhooks

Antes de começar

O Linkly gera solicitações de API na interface para você copiar e colar em seus aplicativos.

Isso funciona para criação de links e atualização de links.

Economize tempo e deixe que fazemos o trabalho pesado:

1. 1
   Veja abaixo as solicitações de API de criação de links.
2. 2
   Copie as solicitações na íntegra. Você pode verificar se funcionam para você.
3. 3
   Peça ao ChatGPT ou equivalente para adaptar essas solicitações em código-fonte para seu aplicativo. Não há necessidade de gastar tempo em uma integração complexa. Nossa API é inteiramente consumível por máquina.

---

Especificação OpenAPI 3.0

Você pode gerar solicitações de API diretamente da interface do usuário do Linkly.

A API do Linkly é documentada usando o padrão OpenAPI, que vai além do que é fornecido abaixo. Os mesmos endpoints também estão disponíveis como uma coleção Postman de um clique.

Visualizar Especificação OpenAPI

Executar no Postman

Autorização

Você precisará de:

• Sua Chave de API
• ID do Espaço de Trabalho

Você pode obter esses detalhes dentro do Linkly.

1. 1
   Faça login no Linkly.
2. 2
   Clique em Configurações.
3. 3
   Clique em Chaves de API.

Criar ou atualizar um link

Para criar um link, tudo que você precisa fazer é enviar uma solicitação POST para:

https://app.linklyhq.com/api/v1/link

com os seguintes campos no corpo.

O tipo de codificação é x-www-form-urlencoded ou application/json.

Se você está enviando o campo Rules, você deve usar application/json.

Recomendamos que você use JSON com a especificação Open API.

Exemplo de solicitação usando curl

O código abaixo ilustra como fazer uma solicitação de API para criar um link.

curl -X POST https://app.linklyhq.com/api/v1/link
-H 'cache-control: no-cache'
-d 'api_key=your_secret_key&workspace_id=1&url=http%3A%2F%2Fwww.wikijob.co.uk&name=Test%20Link'

Uma resposta bem-sucedida retornará um objeto JSON representando o link, juntamente com um id do link.

{
    "id": 9512,
    "url": "https://www.wikijob.co.uk",
    "name": "Test Link",
    "note": null,
    "head_tags": null,
    "body_tags": null,
    "linkify_words": null,
    "replacements": null,
    "enabled": true,
    "cloaking": false,
    "forward_params": false,
    "hide_referrer": false,
    "block_bots": false,
    "skip_social_crawler_tracking": false,
    "public_analytics": false,
    "password": null,
    "domain": null,
    "slug": null,
    "utm_source": null,
    "utm_medium": null,
    "utm_campaign": null,
    "utm_term": null,
    "utm_content": null,
    "og_title": null,
    "og_description": null,
    "og_image": null,
    "fb_pixel_id": null,
    "tiktok_pixel_id": null,
    "ga4_tag_id": null,
    "gtm_id": null,
    "full_url": "https://l.linklyhq.com/l/2TQ",
    "rules": [],
    "expiry_datetime": null,
    "expiry_destination": null,
    "expiry_clicks": null,
    "qr_styles": null,
    "webhooks": [],
    "notify_user_ids": [],
    "workspace_id": 1448,
    "deleted": false
}

Atualizar um link

Para atualizar um link, envie a mesma solicitação que você usaria para criar o link, mas inclua o campo id para o link que você deseja atualizar, bem como as alterações.

Criar rotadores via API

Para criar um rotador, envie um campo chamado rules como um array JSON, juntamente com a carga do link acima. Você deve usar application/json para enviar arrays JSON.

Por exemplo:

[
  {"what": "rotator", "url": "https://www.microsoft.com", "percentage": "50"},
  {"what": "rotator", "url": "https://www.apple.com", "percentage": "50"}
]

Criar redirecionamentos geo via API

Para redirecionar por país, envie um campo chamado rules como um array JSON, juntamente com a carga do link acima. Você deve usar codificação application/json para enviar arrays JSON.

Por exemplo:

[
  {"what": "country", "url": "https://www.microsoft.com", "matches": "UK"},
  {"what": "country", "url": "https://www.apple.com", "matches": "US"}
]

O país é o código de país ISO 3166 alfa-2.

Criar redirecionamentos de dispositivo via API

Para redirecionar por dispositivo, envie um campo chamado rules como um array JSON, juntamente com a carga do link acima.

Por exemplo:

[
  {"what": "platform", "url": "https://www.google.com", "matches": "windows"},
  {"what": "platform", "url": "https://www.apple.com", "matches": "ios"}
]

Onde o campo matches é um de:

• ios
• android
• windows
• linux
• mac

Criar ou atualizar múltiplos links em uma solicitação

O Linkly suporta a criação/alteração de até 1000 links por solicitação.

Para fazer isso, envie sua chave de API como parte da solicitação da seguinte forma:

https://app.linklyhq.com/api/v1/link?api_key=XXXXXXXXXXX

Então, use o mesmo esquema acima para os casos de links individuais, mas envolva as solicitações de link em um array, da forma:

[{link}, {link}]

Aqui está uma solicitação completa que atualizará dois links:

wget --no-check-certificate \
  --method POST \
  --timeout=0 \
  --header 'Content-Type: application/json' \
  --body-data '[
    {
        "workspace_id": "WORKSPACE_ID",
        "url": "https://nature.com",
        "name": "Test",
        "id": LINK_ID
    },
    {
        "workspace_id": "WORKSPACE_ID",
        "url": "https://science.com",
        "id": LINK_ID
    }
]' \
   'https://app.linklyhq.com/api/v1/workspace/WORKSPACE_ID/links?api_key=API_KEY'

Isso funciona tanto para ações de criação quanto de atualização.

Esteja ciente de que pode levar até 60 segundos para uma solicitação grande. Se as solicitações levarem mais tempo que isso, elas falharão, e você deve considerar dividir sua carga de trabalho em chunks menores.

Limites de taxa

A API de encurtamento de links é limitada a 20 solicitações/segundo. Até 200 solicitações por segundo estão disponíveis sob demanda. Você pode fazer upload de até 1000 links em uma única solicitação.

Relacionado

• API de Análise - Exporte dados de cliques e relatórios de tráfego
• Webhooks - Notificações de cliques em tempo real
• Integração do Zapier - Integrações sem código