본문 바로가기

API

URL 단축 API 사용 방법, nly.kr API Key로 단축 URL 생성하기

반복적으로 URL을 단축해야 하거나, 서비스 안에 URL 단축 기능을 직접 연동하고 싶다면 nly.kr URL 단축 API를 사용할 수 있습니다.

개요

nly.kr URL 단축 API는 API Key 인증을 통해 요청하며, 요청 시 원본 URL을 전달하면 단축된 링크를 응답으로 받는 방식으로 동작합니다. 정확한 요청 주소, 파라미터명, 응답 필드 구조는 nly.kr API 안내 페이지(https://nly.kr/api)에서 최신 내용을 확인하는 것이 가장 정확합니다.

인증 방식

API 요청 시 API Key를 함께 전달해 인증합니다. API Key는 nly.kr API 페이지에서 발급받을 수 있습니다.

요청 예시 (구조 예시)

아래는 API Key 인증과 원본 URL 전달이라는 공통 구조를 보여주는 예시입니다. 실제 필드명과 엔드포인트는 공식 문서 기준으로 다를 수 있으니 사용 전 반드시 확인하세요.

fetch("https://nly.kr/api/{엔드포인트}", {
method: "POST",
headers: {
"Content-Type": "application/json",
"Authorization": "Bearer your_API_KEY"
},
body: JSON.stringify({
url: "https://www.example.com/very/long/original/url"
})
});

응답에서 확인할 수 있는 값

응답에는 생성된 단축 URL(https://nly.kr/{코드} 형태)이 포함됩니다. 정확한 응답 필드명은 공식 API 문서를 기준으로 확인하는 것이 안전합니다.

알아두면 좋은 점

  • API 요청에는 rate limit(요청 횟수 제한)이 존재합니다.
  • 실제 서비스에 연동하기 전, 테스트 환경에서 요청/응답 구조를 먼저 확인하는 것이 안전합니다.
  • API Key는 외부에 노출되지 않도록 서버 사이드에서 관리하는 것을 권장합니다.

문제가 생긴 경우

증상: API 요청이 실패한다

확인할 내용: API Key가 정확히 전달되었는지, 요청 형식(헤더, 파라미터)이 공식 문서와 일치하는지, rate limit을 초과하지 않았는지 확인합니다.

해결 방향: 요청 헤더와 인증 정보를 다시 확인한 뒤 재시도합니다. 반복적으로 실패한다면 API Key 재발급 여부를 확인합니다.

마무리

API 연동 전 전체 요청·응답 구조는 nly.kr API 페이지(https://nly.kr/api)에서 먼저 확인하는 것을 권장합니다.