API de Encurtamento de Links da Linkly

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

Relacionado: API de Analytics | Webhooks

Antes de Começar

A Linkly gera solicitações de API na interface para você copiar e colar em suas aplicações.

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

Economize tempo e deixe-nos fazer o trabalho pesado:

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

Especificação OpenAPI 3.0

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

Linkly's Link Shortening API Builder

A API de encurtamento de links da Linkly constrói solicitações de API automaticamente com base no conteúdo do formulário. Você pode colar o texto fornecido aqui em qualquer LLM para gerar código automaticamente para sua aplicação.

A API da Linkly é documentada usando o padrão OpenAPI, que vai além do que é fornecido abaixo.

Autorização

Você precisará de:

  • Sua Chave de API
  • ID do Workspace

Você pode obter esses detalhes dentro da Linkly.

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

Criando ou atualizando um link

Para criar um link, tudo o 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ê estiver enviando o campo Rules, deve usar application/json.

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

RótuloChaveTipoNotas
Chave de API da Contaapi_keyStringObrigatório
ID do Workspaceworkspace_idIntegerObrigatório
ID do LinkidIntegerObrigatório se estiver atualizando um link existente
DestinourlStringObrigatório
ApelidonameString
NotasnoteString
Tags de retargeting (região head)head_tagsStringPara pixels de retargeting
Tags de retargeting (região body)body_tagsStringPara pixels de retargeting
Encaminhar Parâmetrosforward_paramsBoolean
Status de PublicaçãoenabledBoolean
UTM Sourceutm_sourceStringPara rastreamento UTM
UTM Mediumutm_mediumStringPara rastreamento UTM
UTM Campaignutm_campaignStringPara rastreamento UTM
UTM Termutm_termStringPara rastreamento UTM
UTM Contentutm_contentStringPara rastreamento UTM
Domínio PersonalizadodomainStringObrigatório se o slug for fornecido. Veja domínios personalizados
Sufixo do Domínio PersonalizadoslugStringSe o domínio for fornecido e o slug for nulo, será gerado automaticamente
Título Open Graphog_titleStringPara prévias de mídia social
Descrição Open Graphog_descriptionStringPara prévias de mídia social
URL da Imagem Open Graphog_imageStringPara prévias de mídia social
ID do Meta Pixelfb_pixel_idStringPara Meta Pixel
ID do Google Analytics 4ga4_tag_idString
Container do Google Tag Managergtm_idString
Data/Hora de Expiraçãoexpiry_datetimeString DateTime ISO8601Para links com expiração
Destino de Expiraçãoexpiry_destinationStringPara links com expiração
RegrasrulesArray JSONPara rotacionadores, redirecionamentos geográficos e redirecionamentos de dispositivo

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,
    "alias": null,
    "url": "https://www.wikijob.co.uk",
    "name": "Test Link",
    "note": null,
    "head_tags": null,
    "body_tags": null,
    "linkify_words": null,
    "enabled": true,
    "cloaking": false,
    "replacements": 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,
    "full_url": "https://l.linklyhq.com/l/2TQ",
    "block_bots": false,
    "rules": [],
    "workspace_id": 1448,
    "referer_mode": null,
    "custom_referer": null,
    "click_fraud_mode": null,
    "deleted": false
}

Atualizando um link

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

Criando Rotacionadores via API

Para criar um rotacionador, envie um campo chamado rules como um array JSON, juntamente com o payload 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"}
]

Criando Redirecionamentos Geográficos via API

Para redirecionar por país, envie um campo chamado rules como um array JSON, juntamente com o payload 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 alpha-2 ISO 3166.

Criando Redirecionamentos de Dispositivo via API

Para redirecionar por dispositivo, envie um campo chamado rules como um array JSON, juntamente com o payload 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

Criando ou Atualizando Múltiplos Links em Uma Solicitação

A 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

Em seguida, 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 demorarem mais do que isso, elas falharão, e você deve considerar dividir sua carga de trabalho em partes 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 mediante solicitação. Você pode fazer upload de até 1000 links em uma única solicitação.

Relacionado

Track 1000 monthly clicks with all features included.

No credit card required