Linkly의 링크 단축 API

Linkly의 링크 단축 API를 사용하여 프로그래밍 방식으로 링크를 만들고, 업데이트하고, 관리하세요.

관련: 분석 API | 웹훅

시작하기 전에

Linkly는 인터페이스에서 API 요청을 생성하여 애플리케이션에 복사하여 붙여넣을 수 있도록 합니다.

이는 링크 생성 및 링크 업데이트에 적용됩니다.

시간을 절약하고 어려운 작업을 맡기세요:

  1. 1
    아래에서 링크 생성 API 요청을 확인하세요.
  2. 2
    요청을 전체적으로 복사하세요. 작동하는지 확인할 수 있습니다.
  3. 3
    ChatGPT 또는 동등한 도구에 이러한 요청을 애플리케이션의 소스 코드로 조정하도록 요청하세요. 복잡한 통합을 하는 데 시간을 쏟을 필요가 없습니다. 당사의 API는 완전히 머신 가독 가능합니다.

OpenAPI 3.0 사양

Linkly 사용자 인터페이스에서 직접 API 요청을 생성할 수 있습니다.

Linkly의 링크 단축 API 빌더

Linkly의 링크 단축 API는 양식의 내용을 기반으로 API 요청을 자동으로 빌드합니다. 여기에서 제공된 텍스트를 모든 LLM에 붙여넣어 애플리케이션을 위한 코드를 자동으로 생성할 수 있습니다.

Linkly의 API는 OpenAPI 표준을 사용하여 문서화되어 있으며, 아래에서 제공되는 것 이상의 기능을 갖고 있습니다. 동일한 엔드포인트는 원클릭 Postman 컬렉션으로도 사용 가능합니다.

OpenAPI 사양 보기

Postman에서 실행

인증

다음이 필요합니다:

  • API 키
  • 워크스페이스 ID

Linkly 내에서 이러한 세부 정보를 얻을 수 있습니다.

  1. 1
    Linkly에 로그인합니다.
  2. 2
    설정을 클릭합니다.
  3. 3
    API 키를 클릭합니다.

링크 만들기 또는 업데이트하기

링크를 만들려면 POST 요청을 다음으로 보내기만 하면 됩니다:

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

본문에 다음 필드가 있습니다.

인코딩 유형은 x-www-form-urlencoded 또는 application/json입니다.

규칙 필드를 제출하는 경우 application/json을 사용해야 합니다.

Open API 사양과 함께 JSON을 사용하는 것이 좋습니다.

레이블키타입참고
계정 API 키api_key문자열필수
워크스페이스 IDworkspace_id정수필수
링크 IDid정수기존 링크를 업데이트하는 경우 필수
대상url문자열필수
닉네임name문자열
메모note문자열
메타데이터metadata객체시스템의 ID와 같은 고유 키-값 데이터입니다. 메타데이터 참조
리타게팅 태그 (head 영역)head_tags문자열리타게팅 픽셀용
리타게팅 태그 (body 영역)body_tags문자열리타게팅 픽셀용
매개변수 전달forward_params부울
리퍼러 숨기기hide_referrer부울대상이 리퍼러 헤더에서 Linkly를 보지 않도록 referrer-policy: no-referrer을 보냅니다
클로킹cloaking부울프레임 뒤에 대상 URL을 마스킹합니다
봇 차단block_bots부울알려진 봇/크롤러를 차단합니다
소셜 크롤러 추적 건너뛰기skip_social_crawler_tracking부울block_bots가 켜져 있을 때도 소셜 크롤러를 통과하여 OG 미리보기가 작동하도록 합니다
공개 분석public_analytics부울이 링크에 대해 공개 /abc123.stats 페이지를 활성화합니다
비밀번호password문자열방문자는 리디렉션 전에 이 비밀번호를 입력해야 합니다
발행 상태enabled부울
UTM 소스utm_source문자열UTM 추적용
UTM 중간utm_medium문자열UTM 추적용
UTM 캠페인utm_campaign문자열UTM 추적용
UTM 용어utm_term문자열UTM 추적용
UTM 콘텐츠utm_content문자열UTM 추적용
사용자 정의 도메인domain문자열slug가 제공된 경우 필수입니다. 사용자 정의 도메인 참조
사용자 정의 도메인 접미사slug문자열도메인이 제공되고 slug가 null인 경우 자동으로 생성됩니다
Open Graph 제목og_title문자열소셜 미디어 미리보기용
Open Graph 설명og_description문자열소셜 미디어 미리보기용
Open Graph 이미지 URLog_image문자열소셜 미디어 미리보기용
Meta 픽셀 IDfb_pixel_id문자열Meta 픽셀용
TikTok 픽셀 IDtiktok_pixel_id문자열
Google Analytics 4 IDga4_tag_id문자열
Google Tag Manager 컨테이너gtm_id문자열
Linkify 단어linkify_words문자열랜딩 페이지에서 자동으로 단축되어야 하는 개행 구분 구문
대체replacements문자열대상 페이지에 적용되는 텍스트 대체 규칙
만료 날짜 시간expiry_datetimeISO8601 DateTime 문자열만료 링크용
만료 대상expiry_destination문자열 (URL)만료 링크용. http로 시작해야 합니다.
만료 클릭expiry_clicks정수이 많은 클릭 후 링크 만료
웹훅webhooks문자열 배열링크별 웹훅 URL입니다. 웹훅 참조.
사용자 ID 알림notify_user_ids정수 배열각 클릭 시 알림할 워크스페이스 사용자 ID
QR 코드 스타일qr_stylesJSON 객체QR 코드 스타일링용. 키: fgColor, bgColor, qrStyle, eyeStyle, eyeColorInner, eyeColorOuter, logoImage, logoWidth, logoHeight, logoPadding, logoStyle, quietZone
규칙rulesJSON 배열회전기, 지역 리디렉션, 기기 리디렉션용

curl을 사용한 예제 요청

아래 코드는 링크를 만들기 위한 API 요청을 하는 방법을 보여줍니다.

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'

성공적인 응답은 링크를 나타내는 JSON 객체와 함께 링크 ID를 반환합니다.

{
    "id": 9512,
    "url": "https://www.wikijob.co.uk",
    "name": "Test Link",
    "note": null,
    "metadata": {},
    "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
}

링크 업데이트하기

링크를 업데이트하려면 링크를 만드는 데 사용하는 것과 동일한 요청을 보내되, 업데이트할 링크의 id 필드와 변경 사항을 포함합니다.

링크에 고유 데이터 연결하기 (메타데이터)

메타데이터를 사용하여 주문 ID, CRM 연락처 ID 또는 고유 시스템의 캠페인 참조와 같은 고유 식별자를 링크에 저장하세요. 이는 키-값 쌍의 집합이며, 링크를 가져올 때 그리고 모든 웹훅 페이로드(클릭 및 링크 이벤트)에서 반환되므로 클릭을 소속된 레코드와 일치시킬 수 있습니다.

JSON 요청 본문에 객체로 보냅니다:

curl -X POST https://app.linklyhq.com/api/v1/link
-H 'Content-Type: application/json'
-d '{"api_key": "your_secret_key", "workspace_id": 1, "url": "https://example.com", "metadata": {"order_id": "A-10293", "crm_contact_id": "3f2b8c1e-9a47-4d0e-b6a5-1c2d3e4f5a6b"}}'

응답의 링크에는 "metadata": {"order_id": "A-10293", "crm_contact_id": "3f2b8c1e-9a47-4d0e-b6a5-1c2d3e4f5a6b"}가 포함됩니다.

작동 방식:

  • 업데이트는 병합됩니다. 링크를 업데이트할 때, 보내는 키는 링크의 기존 메타데이터에 추가되고, 언급하지 않은 키는 그대로 유지됩니다. 키를 제거하려면 null로 설정하세요 (예: {"metadata": {"order_id": null}}).
  • 값은 문자열입니다. 숫자와 부울은 텍스트로 저장되므로 42는 "42"로 돌아옵니다. 중첩된 객체와 배열은 허용되지 않습니다.
  • 제한사항. 링크당 최대 20개 키, 키는 최대 40자, 값은 최대 500자(UUID 충분).
  • 귀하에게만 비공개입니다. 메타데이터는 링크를 클릭하는 사람에게 절대 표시되지 않으며, 리디렉션을 빌드하는 데 사용되지 않으며, 대상 URL에 추가되지 않습니다.
  • 앱에서. 링크의 자동화 설정의 메타데이터 아래에서 메타데이터를 보고 편집할 수도 있습니다.

메타데이터, 메모 및 UTM 매개변수

메타데이터, 메모 필드 및 UTM 매개변수는 모두 링크를 설명하지만 다양한 작업을 수행합니다:

  • 메타데이터는 고유 시스템을 위한 구조화된 키-값 데이터입니다. API에 의해 반환되고 웹훅에서 전송되므로 소프트웨어가 이를 읽을 수 있습니다.
  • 메모는 사람이 앱에서 읽을 수 있도록 하는 단일 자유 형식 필드입니다.
  • UTM 매개변수는 대상 URL에 추가되므로 방문자를 보내는 페이지와 그 분석에서 이를 볼 수 있습니다. 메타데이터는 절대 그렇지 않습니다. 대상 페이지에 값을 전달하려면 UTM 매개변수를 사용하거나 짧은 링크의 쿼리 매개변수가 통과하도록 매개변수 전달을 켜세요.

메타데이터 및 분석

메타데이터는 클릭 분석 또는 클릭 내보내기에 포함되지 않으며, 메타데이터별로 클릭을 그룹화하거나 필터링하거나 링크를 검색할 수 없습니다. 클릭을 고유 레코드와 연결하려면 링크의 id를 사용하세요. 웹훅 페이로드, 링크별로 분류된 분석, 및 링크 응답에 나타납니다. 귀하의 쪽에서 링크 id로부터 레코드를 조회하거나, 링크를 가져와 메타데이터를 읽으세요.

API를 통한 회전기 만들기

회전기를 만들려면 위의 링크 페이로드와 함께 rules이라는 필드를 JSON 배열로 제출하세요. JSON 배열을 보내려면 application/json을 사용해야 합니다.

예:

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

API를 통한 지역 리디렉션 만들기

국가별로 리디렉션하려면 위의 링크 페이로드와 함께 rules이라는 필드를 JSON 배열로 제출하세요. JSON 배열을 보내려면 application/json 인코딩을 사용해야 합니다.

예:

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

국가는 **알파-2 ISO 3166 국가 코드**입니다.

API를 통한 기기 리디렉션 만들기

기기별로 리디렉션하려면 위의 링크 페이로드와 함께 rules이라는 필드를 JSON 배열로 제출하세요.

예:

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

matches 필드는 다음 중 하나입니다:

  • ios
  • android
  • windows
  • linux
  • mac

한 요청에서 여러 링크 만들기 또는 업데이트하기

Linkly는 요청당 최대 1000개의 링크를 생성/수정할 수 있습니다.

그렇게 하려면 다음과 같이 요청의 일부로 API 키를 제출하세요:

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

그런 다음 개별 링크 경우와 동일한 스키마를 사용하되, 링크 요청을 다음 형식의 배열로 래핑하세요:

[{link}, {link}]

두 개의 링크를 업데이트할 완전한 요청은 다음과 같습니다:

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/links?api_key=API_KEY'

이는 생성 및 업데이트 작업 모두에서 작동합니다.

대용량 요청은 최대 60초가 걸릴 수 있음을 유의하세요. 요청이 이보다 오래 걸리면 실패하며, 작업 부하를 더 작은 청크로 나누는 것을 고려해야 합니다.

속도 제한

링크 단축 API는 초당 20개 요청으로 제한됩니다. 초당 최대 200개 요청은 요청 시 사용 가능합니다. 단일 요청에서 최대 1000개의 링크를 업로드할 수 있습니다.

관련

이용 가능 요금제

모든 요금제에 포함

요금제 비교 →

월 500회 클릭 추적 무료.