How to Create Short Links via the CodeQR API: Complete Guide

How to Create Short Links via the CodeQR API: Complete Guide | CodeQR.io

Authorization: Bearer codeqr_xxxxxxxx

https://api.codeqr.io

curl --request POST \
  --url https://api.codeqr.io/links \
  --header 'Authorization: Bearer codeqr_your_api_key' \
  --header 'Content-Type: application/json' \
  --data '{"url": "https://codeqr.io"}'

{
	"id": "clwc7hxcd0001ab6tqskb0h7v",
	"domain": "codeqr.link",
	"key": "site",
	"url": "https://codeqr.io",
	"archived": false,
	"expiresAt": null,
	"expiredUrl": null,
	"password": null,
	"externalId": null,
	"trackConversion": true,
	"proxy": true,
	"title": "CodeQR - Smart QR Codes, Short Links & Custom Pages",
	"description": "Create, manage, and track intelligent QR Codes, dynamic short links, and personalized landing pages. Boost engagement and gain valuable insights for your business.",
	"image": "https://res.cloudinary.com/dhnaggn4g/image/upload/c_thumb,w_200,g_face/v1750078911/static/codeqr_thumbnail_abgafw.png",
	"video": null,
	"utm_source": null,
	"utm_medium": null,
	"utm_campaign": null,
	"utm_term": null,
	"utm_content": null,
	"rewrite": false,
	"doIndex": false,
	"flexible": false,
	"filled": false,
	"ios": null,
	"android": null,
	"geo": null,
	"userId": "cloukebiw0000ig8g2q4w6vbp",
	"projectId": "clwazhjsm00002nx4heuc6vge",
	"preRedirection": false,
	"pageId": null,
	"pageUrl": null,
	"isFormMandatory": false,
	"publicStats": false,
	"clicks": 21,
	"lastClicked": "2025-08-30T12:16:06.000Z",
	"leads": 0,
	"sales": 0,
	"saleAmount": 0,
	"createdAt": "2024-05-18T14:31:08.557Z",
	"updatedAt": "2025-09-06T12:21:07.873Z",
	"tagId": null,
	"comments": "Link para landing page ",
	"notificationToken": null,
	"tags": [],
	"shortLink": "https://codeqr.link/site",
	"webhookIds": [],
	"qrCode": "https://api.codeqr.io/qr?url=https://codeqr.link/site?qr=1"
}

const response = await fetch("https://api.codeqr.io/links", {
  method: "POST",
  headers: {
    Authorization: "Bearer sua_chave_api",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    url: "https://codeqr.io",
  }),
});

const link = await response.json();
console.log("Link criado:", link.shortLink);
console.log("QR Code:", link.qrCode);

curl --request POST \
  --url https://api.codeqr.io/links \
  --header 'Authorization: Bearer codeqr_your_api_key' \
  --header 'Content-Type: application/json' \
  --data '{
    "url": "https://example.com",
    "proxy": true,
    "title": "Special Promotion - 50% OFF",
    "description": "Take advantage of our special promotion with 50% off on all products. Offer valid for a limited time!",
    "image": "https://example.com/promo-banner.jpg"
}'

curl --request POST \
  --url https://api.codeqr.io/links \
  --header 'Authorization: Bearer codeqr_your_api_key' \
  --header 'Content-Type: application/json' \
  --data '{
    "url": "https://codeqr.io",
    "tagIds": ["tag1", "tag2"],
    "tagNames": "marketing-campaign"
  }'

curl --request POST \
  --url https://api.codeqr.io/links \
  --header 'Authorization: Bearer codeqr_your_api_key' \
  --header 'Content-Type: application/json' \
  --data '{
    "url": "https://codeqr.io/",
    "password": "123456",
    "expiresAt": "2026-12-31T23:59:59Z",
    "expiredUrl": "https://examplo.com/expirado"
  }'

curl --request POST \
  --url https://api.codeqr.io/links \
  --header 'Authorization: Bearer codeqr_your_api_key' \
  --header 'Content-Type: application/json' \
  --data '{
    "url": "https://examplo.com",
    "ios": "https://apps.apple.com/app/examplo",
    "android": "https://play.google.com/store/apps/details?id=com.examplo"
  }'

curl --request POST \
  --url https://api.codeqr.io/links \
  --header 'Authorization: Bearer codeqr_your_api_key' \
  --header 'Content-Type: application/json' \
  --data '{
    "url": "https://examplo.com",
    "geo": {
      "BR": "https://examplo.com/brasil",
      "US": "https://examplo.com/usa",
      "GB": "https://examplo.com/uk"
    }
  }'

curl --request POST \
  --url https://api.codeqr.io/links \
  --header 'Authorization: Bearer codeqr_your_api_key' \
  --header 'Content-Type: application/json' \
  --data '{
    "url": "https://examplo.com",
    "utm_source": "marketing",
    "utm_medium": "email",
    "utm_campaign": "promotion_2025",
    "utm_term": "product",
    "utm_content": "banner"
  }'

curl --request POST \
  --url https://api.codeqr.io/links \
  --header 'Authorization: Bearer codeqr_your_api_key' \
  --header 'Content-Type: application/json' \
  --data '{
    "url": "https://examplo.com",
    "trackConversion": true,
    "utm_source": "facebook",
    "utm_medium": "social",
    "utm_campaign": "black_friday"
  }'

curl --request POST \
  --url https://api.codeqr.io/links \
  --header 'Authorization: Bearer codeqr_your_api_key' \
  --header 'Content-Type: application/json' \
  --data '{
    "url": "https://example.com/very-long-and-complex-page",
    "rewrite": true,
    "key": "clean-link"
  }'

curl --request POST \
  --url https://api.codeqr.io/links \
  --header 'Authorization: Bearer codeqr_your_api_key' \
  --header 'Content-Type: application/json' \
  --data '{
    "url": "https://example.com",
    "doIndex": true,
    "title": "Important Page",
    "description": "Content that should be indexed by search engines"
  }'

curl --request POST \
  --url https://api.codeqr.io/links/bulk \
  --header 'Authorization: Bearer codeqr_your_api_key' \
  --header 'Content-Type: application/json' \
  --data '[
    {
      "url": "https://product1.com",
      "key": "product-1"
    },
    {
      "url": "https://product2.com",
      "key": "product-2"
    },
    {
      "url": "https://product3.com",
      "key": "product-3"
    }
  ]'

curl --request PATCH \
  --url https://api.codeqr.io/links/bulk \
  --header 'Authorization: Bearer codeqr_your_api_key' \
  --header 'Content-Type: application/json' \
  --data '{
    "link_ids": ["link1", "link2", "link3"],
    "data": {
      "utm_source": "facebook",
      "utm_medium": "cpc",
      "tagIds": ["campaign-2025"]
    }
  }'

curl --request DELETE \
  --url https://api.codeqr.io/links/bulk?linkIds=link1,link2,link3 \
  --header 'Authorization: Bearer codeqr_your_api_key'

curl --request POST \
  --url https://api.codeqr.io/links \
  --header 'Authorization: Bearer codeqr_your_api_key' \
  --header 'Content-Type: application/json' \
  --data '{
    "url": "https://example.com",
    "externalId": "12345"
  }'

curl --request GET \
  --url "https://api.codeqr.io/links/info?external_id=12345" \
  --header 'Authorization: Bearer codeqr_your_api_key'

curl --request POST \
  --url https://api.codeqr.io/links \
  --header 'Authorization: Bearer codeqr_your_api_key' \
  --header 'Content-Type: application/json' \
  --data '{
    "url": "https://example.com",
    "tenantId": "usuario123"
  }'

curl --request GET \
  --url "https://api.codeqr.io/links?tenantId=usuario123" \
  --header 'Authorization: Bearer codeqr_your_api_key'

curl --request POST \
  --url https://api.codeqr.io/links \
  --header 'Authorization: Bearer codeqr_your_api_key' \
  --header 'Content-Type: application/json' \
  --data '{
    "url": "https://example.com",
    "tagIds": ["clux0rgak00011..."]
  }'

curl --request GET \
  --url "https://api.codeqr.io/links?tagNames=marketing" \
  --header 'Authorization: Bearer codeqr_your_api_key'

async function criarLinkProduto(produto) {
  const response = await fetch("https://api.codeqr.io/links", {
    method: "POST",
    headers: {
      Authorization: "Bearer codeqr_your_api_key",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      url: `https://loja.com/produto/${produto.id}`,
      key: `produto-${produto.id}`,
      title: produto.nome,
      description: `Link para ${produto.nome}`,
      externalId: produto.sku,
      utm_source: "ecommerce",
      utm_medium: "link_curto",
      utm_campaign: "produto",
      tagIds: ["produtos", "ecommerce"],
    }),
  });

  return await response.json();
}

// Uso
const produto = {
  id: 123,
  nome: "Smartphone XYZ",
  sku: "SP-123",
};

const link = await criarLinkProduto(produto);
console.log("Link criado:", link.shortLink);

import requests
import json

def criar_link_campanha(url_destino, nome_campanha, canal):
    data = {
        "url": url_destino,
        "key": f"campanha-{nome_campanha.lower().replace(' ', '-')}",
        "title": f"Campanha - {nome_campanha}",
        "description": f"Link para campanha {nome_campanha} via {canal}",
        "utm_source": canal,
        "utm_medium": "link_curto",
        "utm_campaign": nome_campanha.lower().replace(' ', '-'),
        "tagNames": [nome_campanha, canal]
    }

    response = requests.post(
        'https://api.codeqr.io/links',
        headers={
            'Authorization': 'Bearer codeqr_your_api_key',
            'Content-Type': 'application/json'
        },
        data=json.dumps(data)
    )

    if response.status_code == 200:
        return response.json()
    else:
        raise Exception(f"Erro: {response.status_code} - {response.text}")

# Uso
link_campanha = criar_link_campanha(
    "https://promocao.com/desconto-50",
    "Black Friday 2025",
    "email"
)
print(f"Link da campanha criado: {link_campanha['shortLink']}")

<?php
function criarLinkAfiliado($url_destino, $afiliado_id, $produto_id) {
    $data = [
        'url' => $url_destino,
        'key' => "afiliado-{$afiliado_id}-{$produto_id}",
        'title' => "Link de Afiliado - Produto {$produto_id}",
        'description' => "Link de afiliado para produto {$produto_id}",
        'externalId' => "afiliado_{$afiliado_id}_{$produto_id}",
        'utm_source' => 'afiliado',
        'utm_medium' => 'link_curto',
        'utm_campaign' => "produto_{$produto_id}",
        'utm_content' => "afiliado_{$afiliado_id}",
        'tagIds' => ['afiliados', "produto-{$produto_id}"]
    ];

    $ch = curl_init();
    curl_setopt($ch, CURLOPT_URL, 'https://api.codeqr.io/links');
    curl_setopt($ch, CURLOPT_POST, true);
    curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
    curl_setopt($ch, CURLOPT_HTTPHEADER, [
        'Authorization: Bearer codeqr_your_api_key',
        'Content-Type: application/json'
    ]);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

    $response = curl_exec($ch);
    $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
    curl_close($ch);

    if ($httpCode === 200) {
        return json_decode($response, true);
    } else {
        throw new Exception("Erro ao criar link: $httpCode");
    }
}

// Uso
$link_afiliado = criarLinkAfiliado(
    "https://loja.com/produto/123",
    "AF001",
    "123"
);
echo "Link de afiliado criado: " . $link_afiliado['shortLink'];
?>

async function criarLinkComPreview(url, titulo, descricao, imagem) {
  const response = await fetch("https://api.codeqr.io/links", {
    method: "POST",
    headers: {
      Authorization: "Bearer codeqr_your_api_key",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      url: url,
      proxy: true,
      title: titulo,
      description: descricao,
      image: imagem,
      trackConversion: true,
      utm_source: "social_media",
      utm_medium: "custom_preview",
      utm_campaign: "viral_campaign",
    }),
  });

  return await response.json();
}

// Uso
const linkPreview = await criarLinkComPreview(
  "https://exemplo.com/promocao",
  "🔥 Promoção Relâmpago - 70% OFF!",
  "Últimas 24h! Aproveite nossa maior promoção do ano com 70% de desconto em todos os produtos. Frete grátis!",
  "https://exemplo.com/banner-promocao.jpg"
);

console.log("Link com preview criado:", linkPreview.shortLink);

import requests
import json

def criar_link_cloaking(url_original, slug_personalizado):
    """
    Cria um link curto com cloaking para mascarar URLs complexas
    """
    data = {
        "url": url_original,
        "key": slug_personalizado,
        "rewrite": True,
        "title": "Acesso Direto",
        "description": "Link direto para o conteúdo",
        "trackConversion": True,
        "utm_source": "cloaking",
        "utm_medium": "clean_url"
    }

    response = requests.post(
        'https://api.codeqr.io/links',
        headers={
            'Authorization': 'Bearer codeqr_your_api_key',
            'Content-Type': 'application/json'
        },
        data=json.dumps(data)
    )

    if response.status_code == 200:
        return response.json()
    else:
        raise Exception(f"Erro: {response.status_code} - {response.text}")

# Uso
url_complexa = "https://exemplo.com/categoria/produto/123?utm_source=email&utm_medium=newsletter&utm_campaign=promocao&ref=cliente&token=abc123"
link_limpo = criar_link_cloaking(url_complexa, "produto-especial")

print(f"URL original: {url_complexa}")
print(f"Link limpo: {link_limpo['shortLink']}")

<?php
function criarLinkIndexavel($url, $titulo, $descricao, $palavras_chave) {
    $data = [
        'url' => $url,
        'key' => strtolower(str_replace(' ', '-', $palavras_chave)),
        'title' => $titulo,
        'description' => $descricao,
        'doIndex' => true,
        'trackConversion' => true,
        'utm_source' => 'seo',
        'utm_medium' => 'organic',
        'tagNames' => ['seo', 'indexavel']
    ];

    $ch = curl_init();
    curl_setopt($ch, CURLOPT_URL, 'https://api.codeqr.io/links');
    curl_setopt($ch, CURLOPT_POST, true);
    curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
    curl_setopt($ch, CURLOPT_HTTPHEADER, [
        'Authorization: Bearer sua_chave_api',
        'Content-Type: application/json'
    ]);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

    $response = curl_exec($ch);
    $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
    curl_close($ch);

    if ($httpCode === 200) {
        return json_decode($response, true);
    } else {
        throw new Exception("Erro ao criar link indexável: $httpCode");
    }
}

// Uso
$link_seo = criarLinkIndexavel(
    "https://exemplo.com/guia-completo-marketing-digital",
    "Guia Completo de Marketing Digital 2025",
    "Aprenda as melhores estratégias de marketing digital para 2025. Dicas práticas, ferramentas e cases de sucesso.",
    "marketing digital 2025"
);

echo "Link indexável criado: " . $link_seo['shortLink'];
?>

curl --request PATCH \
  --url https://api.codeqr.io/links/link_eBKA4MT44XnI17hYLchkjUOd \
  --header 'Authorization: Bearer codeqr_your_api_key' \
  --header 'Content-Type: application/json' \
  --data '{
    "url": "https://novo-destino.com",
    "title": "Novo título"
  }'

curl --request POST \
  --url https://api.codeqr.io/links/update \
  --header 'Authorization: Bearer codeqr_your_api_key' \
  --header 'Content-Type: application/json' \
  --data '{
    "url": "https://exemplo.com",
    "key": "link-estavel"
  }'

curl --request DELETE \
  --url https://api.codeqr.io/links/link_eBKA4MT44XnI17hYLchkjUOd \
  --header 'Authorization: Bearer codeqr_your_api_key'

How to Create Short Links via the CodeQR API: Complete Guide

What is the CodeQR API?

Why use the CodeQR API?

Advantages of integration via API

Common use cases

Initial Setup

1. Get your API key

2. Set up authentication

3. Get Your Project Slug

4. API Base URL

Creating Your First Short Link

Basic link

Important response fields

JavaScript Example

Using the Short Link

Customizing Short Links

Appearance and identification

Custom Link Preview

Organization with tags

Advanced Settings

Access control

Device-based redirection

Location-based redirection

UTM parameters for analytics

Conversion Tracking

Link Cloaking

Search Engine Indexing

Batch Operations

Creating multiple links

Updating multiple links

Deleting multiple links

Organization of Links

External ID

Tenant ID

Tags

Practical Examples

1. Link for E-commerce

2. Link for Marketing Campaign

3. Link for Affiliates

4. Link with Custom Preview for Social Media

5. Link with Cloaking for Complex URLs

6. Indexable Link for SEO

Managing Links

Updating a link

Upsert (Create or Update)

Deleting a link

Error Handling

Common error codes

Best Practices

1. Security

2. Performance

3. Monitoring

4. Organization

Next Steps

1. Link Management

2. Batch Operations

3. Advanced Features

4. SDK Integration

Additional Resources

Official Documentation

Related Articles

Support

Conclusion

Easily Capture Leads at Your Upcoming Events!