Ссылки — это основа Revroute .
Всё в Revroute начинается со ссылки. Будь то:
- несколько ссылок для вашей маркетинговой кампании
- сотни ссылок для вашей партнёрской программы
- тысячи ссылок, программно и пачками, для вашей SMS-кампании — см. массовые операции
В этом руководстве мы рассмотрим модель ссылки, способы создания ссылок и многое другое.
Модель ссылки
Модель ссылки включает следующие свойства:
| Свойство | Описание | Пример |
|---|---|---|
id | Уникальный идентификатор ссылки (с префиксом link_) | link_1KJ1H3PZGE081A22TC6PTQYJP |
url | Целевой URL, куда ведёт ссылка | https://revroute.ru/ |
shortLink | Короткая версия ссылки, включая схему | https://link.revroute.ru/claim |
domain | Домен короткой ссылки | link.revroute.ru |
key | Слаг короткой ссылки | claim |
Полный список полей и правила их заполнения — в разделе «API: введение».
Для отправки конверсионных событий по созданным ссылкам см. «Как работает атрибуция» и клиентский скрипт RevRoute.
Создание ссылки
Поле url, представляющее целевой URL, является единственным обязательным параметром для создания новой короткой ссылки.
import { Revroute } from "dub";
export const dub = new Revroute({
token: process.env.REVROUTE_API_KEY,
});
const link = await dub.links.create({
url: "https://google.com",
});Параметры запроса и формат ответа описаны в разделе «API: введение».
Обновление ссылки
Существующую ссылку можно обновить, передав id в метод update. Этот метод возвращает обновлённую ссылку в ответе.
Вы можете использовать либо linkId, либо externalId с префиксом ext_, который является уникальным идентификатором ссылки в вашей базе данных для связи с ссылкой в системе Revroute.
import { Revroute } from "dub";
export const dub = new Revroute({
token: process.env.REVROUTE_API_KEY,
});
const link = await dub.links.update("link_1KJ1H3PZGE081A22TC6PTQYJP", {
url: "https://www.google.uk", // new URL
});Общие правила работы с API — аутентификация, коды ошибок, пагинация — описаны в разделе «API: введение».
Upsert ссылки
Операция upsert ссылки — это комбинация создания и обновления. Если ссылка с таким же URL уже существует, она будет возвращена (или обновлена при наличии изменений). В противном случае будет создана новая ссылка.
Это позволяет использовать метод upsert без необходимости предварительной проверки существования ссылки.
import { Revroute } from "dub";
export const dub = new Revroute({
token: process.env.REVROUTE_API_KEY,
});
const link = await dub.links.upsert({
url: "https://google.com", // will always be the same short link
});Общие правила работы с API — аутентификация, коды ошибок, пагинация — описаны в разделе «API: введение».