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문자열
리타겟팅 태그 (헤드 영역)head_tags문자열리타겟팅 픽셀
리타겟팅 태그 (본문 영역)body_tags문자열리타겟팅 픽셀
매개변수 전달forward_params부울값
리퍼러 숨기기hide_referrer부울값referrer-policy: no-referrer를 전송하여 대상이 리퍼러 헤더에서 Linkly를 보지 못하게 함
클로킹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_words문자열랜딩 페이지에서 자동으로 단축되어야 하는 줄바꿈으로 구분된 구문
치환replacements문자열대상 페이지에 적용되는 텍스트 교체 규칙
만료 날짜/시간expiry_datetimeISO8601 날짜/시간 문자열만료되는 링크
만료 대상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,
    "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 필드와 변경 사항을 포함합니다.

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회 클릭 추적 무료.