Linkly의 링크 단축 API

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

관련: 분석 API | Webhooks

시작하기 전에

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

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

시간을 절약하고 저희가 어려운 작업을 수행하도록 하세요:

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

OpenAPI 3.0 사양

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

Linkly의 링크 단축 API 빌더

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

Linkly의 API는 아래에 제공된 것 이상의 것을 다루는 OpenAPI 표준을 사용하여 문서화됩니다.

인증

다음이 필요합니다:

  • API 키
  • 워크스페이스 ID

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

  1. 1Linkly에 로그인하세요.
  2. 2설정을 클릭하세요.
  3. 3API 키를 클릭하세요.

링크 생성 또는 업데이트

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

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

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

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

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

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

레이블유형참고
계정 API 키api_key문자열필수
워크스페이스 IDworkspace_id정수필수
링크 IDid정수기존 링크 업데이트 시 필수
목적지url문자열필수
닉네임name문자열
참고note문자열
리타겟팅 태그 (헤드 영역)head_tags문자열리타겟팅 픽셀
리타겟팅 태그 (본문 영역)body_tags문자열리타겟팅 픽셀
파라미터 전달forward_params부울
게시 상태enabled부울
UTM 소스utm_source문자열UTM 추적
UTM 매체utm_medium문자열UTM 추적
UTM 캠페인utm_campaign문자열UTM 추적
UTM 용어utm_term문자열UTM 추적
UTM 콘텐츠utm_content문자열UTM 추적
사용자 지정 도메인domain문자열슬러그가 제공되는 경우 필수. 사용자 지정 도메인 참고
사용자 지정 도메인 접미사slug문자열도메인이 제공되고 슬러그가 null인 경우 자동 생성됨
Open Graph 제목og_title문자열소셜 미디어 미리보기
Open Graph 설명og_description문자열소셜 미디어 미리보기
Open Graph 이미지 URLog_image문자열소셜 미디어 미리보기
Meta 픽셀 IDfb_pixel_id문자열Meta 픽셀
Google Analytics 4 IDga4_tag_id문자열
Google Tag Manager 컨테이너gtm_id문자열
만료 날짜/시간expiry_datetimeISO8601 날짜/시간 문자열만료 링크
만료 목적지expiry_destination문자열만료 링크
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,
    "alias": null,
    "url": "https://www.wikijob.co.uk",
    "name": "Test Link",
    "note": null,
    "head_tags": null,
    "body_tags": null,
    "linkify_words": null,
    "enabled": true,
    "cloaking": false,
    "replacements": 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,
    "full_url": "https://l.linklyhq.com/l/2TQ",
    "block_bots": false,
    "rules": [],
    "workspace_id": 1448,
    "referer_mode": null,
    "custom_referer": null,
    "click_fraud_mode": null,
    "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/link?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/workspace/WORKSPACE_ID/links?api_key=API_KEY'

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

큰 요청의 경우 최대 60초가 걸릴 수 있다는 점을 유의하세요. 요청이 이보다 오래 걸리면 실패하므로 작업을 더 작은 청크로 나누는 것을 고려해야 합니다.

속도 제한

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

관련

모든 기능이 포함된 월 500개 클릭 추적.

신용카드 필요 없음