도메인 목록 API - v5
- 22-06-19
- 2,574 회
- 0 건
도메인 목록 API
v5
목차
1. API 개요
2. 구조 및 응답
2-1. 전송 구조
2-2. 수신 구조
2-3. 응답 및 오류
3. 레퍼런스 코드
🟢 1. API 개요
도메인 목록 API 는 등록한 무료 도메인 목록을 가져옵니다.
v5 버전의 API 부터 API Key 를 발급받아야 사용이 가능합니다.
LRL.KR 로그인 후 https://api.lrl.kr 에서 키 발급이 가능합니다.
🟢 2. 구조 및 응답
- 요청 URL : https://api.lrl.kr/v5/domain/list
- 데이터 타입 : JSON
- 전송 메소드 : GET, POST
GET 방식은 URI 를 통해 데이터 전송이 가능하며, JSON 타입 데이터를 받습니다.
POST 방식은 JSON 타입 데이터를 주고 받습니다.
🔵 2 - 1. 전송 구조
GET
https://api.lrl.kr/v5/domain/list?key=API_KEY
GET 방식을 사용하는 경우 API Key 값만 입력하시면 도메인 목록을 JSON 으로 출력합니다.
POST
{
"key": "API_KEY"
}
POST 방식을 사용하는 경우 JSON 형식에 API Key 값만 넣으면 도메인 목록을 JSON 으로 얻을 수 있습니다.
🔵 2 - 2. 수신 구조
{ "result":[ { "name":"test.ggm.pw", "record":[ { "name":"test.ggm.pw", "type":"A", "content":"1.1.1.1" }, { "name":"name.test.ggm.pw", "type":"A", "content":"1.1.1.0" }] } ], "message":"SUCCESS"}
등록한 무료 도메인 이름과 레코드값 (이름, 레코드 타입, 주소) 정보를 가져옵니다.
🔴 2 - 3. 응답 및 오류
API 는 아래와 같은 http 코드로 응답합니다.
정상적인 응답에는 http 201 값을 반환합니다.
- 200 - 서비스 정상 제공중
- 201 - 요청 성공
- 400 - 잘못된 요청
- 401 - API 키 누락 또는 불일치
- 403 - 접근 불가능
- 404 - 존재하지 않는 리소스
- 405 - 잘못된 요청 메소드
- 500 - 서버 오류. 신고 및 문의 게시판에 제보해주세요.
만약 오류가 난 경우 message 값에 다음 메세지를 반환합니다.
- ERR_NO_KEY : KEY 값을 넣어주세요.
- ERR_NO_DOMAIN_FOUND : 등록된 도메인이 없습니다.
- ERR_UNDEFINED : 알 수 없는 오류. 신고 및 문의 게시판에 제보해주세요.
🟢 3. 레퍼런스 (예제) 코드
레퍼런스는 https://api.lrl.kr/ref/v5/ 에서 확인하실 수 있습니다.
크롬 기준 우클릭 -> 페이지 소스 보기 를 눌러서 코드를 확인하세요.
- 이전글 도메인 수정 API - v5 22.06.19
- 다음글 URL 만들기 API - v5 22.06.19