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 표준을 사용하여 문서화되어 있습니다.
인증
다음이 필요합니다:
- API 키
- 워크스페이스 ID
Linkly 내부에서 이러한 세부 정보를 얻을 수 있습니다.
- 1Linkly에 로그인합니다.
- 2설정을 클릭합니다.
- 3API 키를 클릭합니다.
링크 생성 또는 업데이트
링크를 생성하려면 다음 주소로 POST 요청을 보내기만 하면 됩니다:
https://app.linklyhq.com/api/v1/link
본문에 다음 필드를 포함합니다.
인코딩 타입은 x-www-form-urlencoded 또는 application/json입니다.
Rules 필드를 제출하는 경우 application/json을 사용해야 합니다.
Open API 사양과 함께 JSON을 사용하는 것을 권장합니다.
| 레이블 | 키 | 타입 | 참고사항 |
|---|---|---|---|
| 계정 API 키 | api_key | String | 필수 |
| 워크스페이스 ID | workspace_id | Integer | 필수 |
| 링크 ID | id | Integer | 기존 링크 업데이트 시 필수 |
| 대상 URL | url | String | 필수 |
| 닉네임 | name | String | |
| 메모 | note | String | |
| 리타겟팅 태그 (head 영역) | head_tags | String | 리타겟팅 픽셀용 |
| 리타겟팅 태그 (body 영역) | body_tags | String | 리타겟팅 픽셀용 |
| 매개변수 전달 | forward_params | Boolean | |
| 게시 상태 | enabled | Boolean | |
| UTM 소스 | utm_source | String | UTM 추적용 |
| UTM 매체 | utm_medium | String | UTM 추적용 |
| UTM 캠페인 | utm_campaign | String | UTM 추적용 |
| UTM 키워드 | utm_term | String | UTM 추적용 |
| UTM 콘텐츠 | utm_content | String | UTM 추적용 |
| 커스텀 도메인 | domain | String | slug가 제공된 경우 필수. 커스텀 도메인 참조 |
| 커스텀 도메인 접미사 | slug | String | domain이 제공되고 slug가 null인 경우 자동 생성됩니다 |
| Open Graph 제목 | og_title | String | 소셜 미디어 미리보기용 |
| Open Graph 설명 | og_description | String | 소셜 미디어 미리보기용 |
| Open Graph 이미지 URL | og_image | String | 소셜 미디어 미리보기용 |
| Meta 픽셀 ID | fb_pixel_id | String | Meta 픽셀용 |
| Google Analytics 4 ID | ga4_tag_id | String | |
| Google Tag Manager 컨테이너 | gtm_id | String | |
| 만료 일시 | expiry_datetime | ISO8601 DateTime String | 만료 링크용 |
| 만료 대상 URL | expiry_destination | String | 만료 링크용 |
| 규칙 | rules | JSON array | 로테이터, 지역 리디렉션, 기기 리디렉션용 |
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'
성공적인 응답은 링크 id와 함께 링크를 나타내는 JSON 객체를 반환합니다.
{
"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"}
]
국가는 **alpha-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개의 링크를 업로드할 수 있습니다.