Criar link curto

Informe uma URL e um link encurtado será retornado.

POST /links

cURL

curl \
-H "Authorization: Bearer API_KEY" \
-H 'Content-Type: application/json' \
-d '{"url": "https://www.ayrshare.com", "utmSource": "google_ads"}' \
-X POST https://api.ayrshare.com/api/links

const API_KEY = "API_KEY";

fetch("https://api.ayrshare.com/api/links", {
      method: "POST",
      headers: {
        "Content-Type": "application/json",
        "Authorization": `Bearer ${API_KEY}`
      },
      body: JSON.stringify({
        url: "https://www.ayrshare.com", // required
        utmSource: "google_ads", // optional
      }),
    })
      .then((res) => res.json())
      .then((json) => console.log(json))
      .catch(console.error);

import requests

payload = {'url': 'https://www.ayrshare.com',
        'utmSource': 'google_ads"}
headers = {'Content-Type': 'application/json',
        'Authorization': 'Bearer API_KEY'}

r = requests.post('https://api.ayrshare.com/api/links',
    json=payload,
    headers=headers)

print(r.json())

require 'vendor/autoload.php';// Composer auto-loader using Guzzle. See .../guzzlephp.org/en/stable/overview.html

$client = new GuzzleHttp\Client();
$res = $client->request(
    'POST',
    'https://api.ayrshare.com/api/links',
    [
        'headers' => [
            'Content-Type'  => 'application/json',
            'Authorization' => 'Bearer API_KEY'
        ],
        'json' => [
            'url' => 'https://www.ayrshare.com',
            'utmSource' => 'google_ads', // optional
        ]
    ]
);

echo json_encode(json_decode($res->getBody()), JSON_PRETTY_PRINT);

package main

import (
	"bytes"
	"encoding/json"
	"log"
	"net/http"
)

func main() {
	message := map[string]interface{}{
		"url":      "https://www.ayrshare.com",
		"utmSource": "google_ads",
	}

	bytesRepresentation, err := json.Marshal(message)
	if err != nil {
		log.Fatalln(err)
	}

	req, _ := http.NewRequest("POST", "https://api.ayrshare.com/api/links",
		bytes.NewBuffer(bytesRepresentation))

	req.Header.Add("Content-Type", "application/json; charset=UTF-8")
	req.Header.Add("Authorization", "Bearer API_KEY")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		log.Fatal("Error:", err)
	}

	res.Body.Close()
}

using System;
using System.Net.Http;
using System.Text;
using System.Threading.Tasks;

namespace CreateShortLinkPOSTRequest_csharp
{
class CreateShortLink
{
    private static readonly HttpClient client = new HttpClient();

    static async Task Main(string[] args)
    {
        string API_KEY = "API_KEY";
        string url = "https://api.ayrshare.com/api/analytics/links";

        client.DefaultRequestHeaders.Add("Authorization", "Bearer " + API_KEY);

        string json = "{\"url\" : \"https://www.ayrshare.com\"," +
            "\"utmSource\" :\"google_ads\"";

        try
        {
            var content = new StringContent(json, Encoding.UTF8, "application/json");
            HttpResponseMessage response = await client.PostAsync(url, content);
            response.EnsureSuccessStatusCode();
            string responseBody = await response.Content.ReadAsStringAsync();
            Console.WriteLine(responseBody);
        }
        catch (HttpRequestException e)
        {
            Console.WriteLine($"Error: {e.Message}");
        }
    }
}
}

200: Success

{
    "created": "2023-07-17T15:20:51.118Z",
    "id": "yC0fTl",
    "originalUrl": "https://www.ayrshare.com/?utm_source=looking",
    "shortUrl": "https://ayrs.io/yC0fTl",
    "status": "success",
    "utmSource": "looking"
}

{
  "action": "request",
  "status": "error",
  "code": 126,
  "message": "Shorten URL failed. Please verify the URL is properly formatted and the correct UTM parameters are used."
}

Informe uma URL e um link encurtado será retornado. As análises podem então ser coletadas sobre os cliques, tipo de navegador, etc.

Enviar a mesma URL para encurtamento sempre resultará no mesmo link encurtado. Para gerar um link encurtado único para a mesma URL, você pode adicionar parâmetros de consulta extras a ela. Por exemplo, acrescentar um identificador único como https://ayrshare.com?uniqueId=123 criará um link encurtado distinto.

Você também pode incluir parâmetros UTM, que serão incorporados ao link encurtado.

​

Parâmetros de cabeçalho

​

Parâmetros do corpo

url · string · obrigatório

URL a ser encurtada. Deve ser uma URL válida começando com https://

utmId · string

Usado para identificar a qual campanha de anúncios do Google Analytics esta referência pertence.

utmSource · string

Usado para identificar um mecanismo de busca, nome de newsletter ou outra fonte.

utmMedium · string

Usado para identificar um meio, como e-mail ou custo por clique.

utmCampaign · string

Usado para análise de palavras-chave. Usado para identificar a promoção específica de um produto ou campanha estratégica.

utmTerm · string

Usado para pesquisa paga. Usado para registrar as palavras-chave deste anúncio.

utmContent · string

Usado para testes A/B e anúncios segmentados por conteúdo. Usado para diferenciar anúncios ou links que apontam para a mesma URL.

cURL

curl \
-H "Authorization: Bearer API_KEY" \
-H 'Content-Type: application/json' \
-d '{"url": "https://www.ayrshare.com", "utmSource": "google_ads"}' \
-X POST https://api.ayrshare.com/api/links

const API_KEY = "API_KEY";

fetch("https://api.ayrshare.com/api/links", {
      method: "POST",
      headers: {
        "Content-Type": "application/json",
        "Authorization": `Bearer ${API_KEY}`
      },
      body: JSON.stringify({
        url: "https://www.ayrshare.com", // required
        utmSource: "google_ads", // optional
      }),
    })
      .then((res) => res.json())
      .then((json) => console.log(json))
      .catch(console.error);

import requests

payload = {'url': 'https://www.ayrshare.com',
        'utmSource': 'google_ads"}
headers = {'Content-Type': 'application/json',
        'Authorization': 'Bearer API_KEY'}

r = requests.post('https://api.ayrshare.com/api/links',
    json=payload,
    headers=headers)

print(r.json())

require 'vendor/autoload.php';// Composer auto-loader using Guzzle. See .../guzzlephp.org/en/stable/overview.html

$client = new GuzzleHttp\Client();
$res = $client->request(
    'POST',
    'https://api.ayrshare.com/api/links',
    [
        'headers' => [
            'Content-Type'  => 'application/json',
            'Authorization' => 'Bearer API_KEY'
        ],
        'json' => [
            'url' => 'https://www.ayrshare.com',
            'utmSource' => 'google_ads', // optional
        ]
    ]
);

echo json_encode(json_decode($res->getBody()), JSON_PRETTY_PRINT);

package main

import (
	"bytes"
	"encoding/json"
	"log"
	"net/http"
)

func main() {
	message := map[string]interface{}{
		"url":      "https://www.ayrshare.com",
		"utmSource": "google_ads",
	}

	bytesRepresentation, err := json.Marshal(message)
	if err != nil {
		log.Fatalln(err)
	}

	req, _ := http.NewRequest("POST", "https://api.ayrshare.com/api/links",
		bytes.NewBuffer(bytesRepresentation))

	req.Header.Add("Content-Type", "application/json; charset=UTF-8")
	req.Header.Add("Authorization", "Bearer API_KEY")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		log.Fatal("Error:", err)
	}

	res.Body.Close()
}

using System;
using System.Net.Http;
using System.Text;
using System.Threading.Tasks;

namespace CreateShortLinkPOSTRequest_csharp
{
class CreateShortLink
{
    private static readonly HttpClient client = new HttpClient();

    static async Task Main(string[] args)
    {
        string API_KEY = "API_KEY";
        string url = "https://api.ayrshare.com/api/analytics/links";

        client.DefaultRequestHeaders.Add("Authorization", "Bearer " + API_KEY);

        string json = "{\"url\" : \"https://www.ayrshare.com\"," +
            "\"utmSource\" :\"google_ads\"";

        try
        {
            var content = new StringContent(json, Encoding.UTF8, "application/json");
            HttpResponseMessage response = await client.PostAsync(url, content);
            response.EnsureSuccessStatusCode();
            string responseBody = await response.Content.ReadAsStringAsync();
            Console.WriteLine(responseBody);
        }
        catch (HttpRequestException e)
        {
            Console.WriteLine($"Error: {e.Message}");
        }
    }
}
}

200: Success

{
    "created": "2023-07-17T15:20:51.118Z",
    "id": "yC0fTl",
    "originalUrl": "https://www.ayrshare.com/?utm_source=looking",
    "shortUrl": "https://ayrs.io/yC0fTl",
    "status": "success",
    "utmSource": "looking"
}

{
  "action": "request",
  "status": "error",
  "code": 126,
  "message": "Shorten URL failed. Please verify the URL is properly formatted and the correct UTM parameters are used."
}