Linkly의 링크 단축 API
Linkly의 링크 단축 API를 사용하여 프로그래밍 방식으로 링크를 생성, 업데이트 및 관리할 수 있습니다.
시작하기 전에
Linkly는 인터페이스에서 API 요청을 생성하여 애플리케이션에 복사하여 붙여넣을 수 있도록 합니다.
이는 링크 생성 및 링크 업데이트에 작동합니다.
시간을 절약하고 힘들게 작업하게 하세요:
- 1아래에서 링크 생성 API 요청을 참조하세요.
- 2요청을 전체적으로 복사합니다. 귀사에 작동하는지 확인할 수 있습니다.
- 3ChatGPT 또는 동등한 서비스에 이 요청들을 애플리케이션의 소스 코드로 조정하도록 요청하세요. 복잡한 통합을 하는 데 시간을 소비할 필요가 없습니다. 당사 API는 완전히 기계 가독 가능합니다.
OpenAPI 3.0 사양
Linkly 사용자 인터페이스에서 직접 API 요청을 생성할 수 있습니다.
Linkly의 링크 단축 API 빌더
Linkly의 링크 단축 API는 양식 내용을 기반으로 API 요청을 자동으로 빌드합니다. 여기에 제공된 텍스트를 모든 LLM에 붙여넣어 애플리케이션의 코드를 자동으로 생성할 수 있습니다.
Linkly의 API는 아래에서 제공되는 것을 넘어서는 OpenAPI 표준을 사용하여 문서화됩니다. 동일한 엔드포인트는 원클릭 Postman 컬렉션으로도 제공됩니다.
권한 부여
다음이 필요합니다:
- API 키
- 워크스페이스 ID
이 세부 정보는 Linkly 내에서 얻을 수 있습니다.
- 1Linkly에 로그인합니다.
- 2설정을 클릭합니다.
- 3API 키를 클릭합니다.
링크 생성 또는 업데이트
링크를 생성하려면 다음 주소로 POST 요청을 보내기만 하면 됩니다:
https://app.linklyhq.com/api/v1/link
본문에 다음 필드를 사용합니다.
인코딩 유형은 x-www-form-urlencoded 또는 application/json입니다.
규칙 필드를 제출하는 경우 application/json을 사용해야 합니다.
Open API 사양과 함께 JSON을 사용하는 것이 좋습니다.
| 레이블 | 키 | 유형 | 참고 |
|---|---|---|---|
| 계정 API 키 | api_key | 문자열 | 필수 |
| 워크스페이스 ID | workspace_id | 정수 | 필수 |
| 링크 ID | id | 정수 | 기존 링크를 업데이트하는 경우 필수 |
| 대상 | 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 이미지 URL | og_image | 문자열 | 소셜 미디어 미리보기용 |
| Meta 픽셀 ID | fb_pixel_id | 문자열 | Meta 픽셀용 |
| TikTok 픽셀 ID | tiktok_pixel_id | 문자열 | |
| Google Analytics 4 ID | ga4_tag_id | 문자열 | |
| Google Tag Manager 컨테이너 | gtm_id | 문자열 | |
| 단어 연결 | linkify_words | 문자열 | 랜딩 페이지에서 자동으로 단축되어야 하는 줄 바꿈으로 구분된 구문 |
| 치환 | replacements | 문자열 | 대상 페이지에 적용되는 텍스트 치환 규칙 |
| 만료 날짜/시간 | expiry_datetime | ISO8601 날짜/시간 문자열 | 만료 링크용 |
| 만료 대상 | expiry_destination | 문자열(URL) | 만료 링크용. http로 시작해야 합니다. |
| 만료 클릭 | expiry_clicks | 정수 | 이 많은 클릭 후 링크 만료 |
| 웹훅 | webhooks | 문자열 배열 | 링크별 웹훅 URL입니다. 웹훅 참조. |
| 사용자 ID 알림 | notify_user_ids | 정수 배열 | 각 클릭 시 알림을 받을 워크스페이스 사용자 ID |
| QR 코드 스타일 | qr_styles | JSON 객체 | QR 코드 스타일용. 키: fgColor, bgColor, qrStyle, eyeStyle, eyeColorInner, eyeColorOuter, logoImage, logoWidth, logoHeight, logoPadding, logoStyle, quietZone |
| 규칙 | rules | JSON 배열 | 로테이터, 지역 리디렉션, 기기 리디렉션용 |
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/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회 클릭 추적 무료.