도메인 수정 API - v5
- 22-06-19
- 3,546 회
- 0 건
도메인 수정 API
v5
목차
1. API 개요
2. 구조 및 응답
2-1. 전송 구조
2-2. 수신 구조
2-3. 응답 및 오류
3. 레퍼런스 코드
🟢 1. API 개요
도메인 수정 API 는 등록한 도메인 데이터 및 타입을 수정할 수 있는 API 입니다.
예시로 시놀로지에서 DDNS 서비스로 사용할 수 있습니다. 게시물 참조
v5 버전의 API 부터 API Key 를 발급받아야 사용이 가능합니다.
LRL.KR 로그인 후 https://api.lrl.kr 에서 키 발급이 가능합니다.
🟢 2. 구조 및 응답
- 요청 URL : https://api.lrl.kr/v5/domain/edit
- 데이터 타입 : JSON
- 전송 메소드 : GET, POST
GET 방식은 URI 를 통해 데이터 전송이 가능하며, JSON 타입 데이터를 받습니다.
POST 방식은 JSON 타입 데이터를 주고 받습니다.
🔵 2 - 1. 전송 구조
GET
https://api.lrl.kr/v5/domain/edit?key=API_KEY&name=테스트1.k-r.pw&type=A&content=1.1.1.1
GET 방식을 사용하는 경우 위와 같이 API 를 사용하실 수 있습니다.
key 매개변수에 API 키를 넣어주시고 name 에는 수정할 도메인 이름, type 은 레코드 타입, content 는 IP 또는 기타 데이터 형식을 넣어주시면
도메인을 수정할 수 있습니다.
POST
{
"key": "API_KEY",
"name": "dd.테스트2.k-r.pw",
"type": "A",
"content": "1.0.0.1"
}
POST 방식을 사용하는 경우 위와 같은 JSON 에 API Key 값과 name 에 수정할 도메인 이름, type 에는 도메인 타입, content 에 IP 또는 도메인 데이터를 넣어주시면 도메인을 수정할 수 있습니다.
🔵 2 - 2. 수신 구조
{"result":true,"message":"SUCCESS"}
위 형태의 응답을 받습니다.
성공적으로 도메인을 수정했을 때 result 값이 true 를 반환합니다.
🔴 2 - 3. 응답 및 오류
API 는 아래와 같은 http 코드로 응답합니다.
정상적인 응답에는 http 201 값을 반환합니다.
- 200 - 서비스 정상 제공중
- 201 - 요청 성공
- 400 - 잘못된 요청
- 401 - API 키 누락 또는 불일치
- 403 - 접근 불가능
- 404 - 존재하지 않는 리소스
- 405 - 잘못된 요청 메소드
- 500 - 서버 오류. 신고 및 문의 게시판에 제보해주세요.
만약 오류가 난 경우 message 값에 다음 메세지를 반환합니다.
- ERR_NO_NAME : 수정할 도메인 이름을 넣어주세요.
- ERR_NO_RECORD : 레코드 값을 넣어주세요. ( A, AAAA, CNAME, TXT, SRV 등 )
- ERR_INVALID_RECORD_TYPE : 사용할 수 없는 레코드 타입입니다.
- ERR_NO_CONTENT : 도메인 IP / 데이터 값을 넣어주세요.
- ERR_INVALID_A_RECORD_DATA : A 레코드에서 사용할 수 없는 IPv4 형식입니다.
- ERR_INVALID_AAAA_RECORD_DATA : AAAA 레코드에서 사용할 수 없는 IPv6 형식입니다.
- ERR_EDIT_FAILED : 본인이 등록한 도메인이 아니거나, 너무 빠른 시간 내에 도메인을 수정한 경우 나옵니다.
- ERR_UNDEFINED : 알 수 없는 오류. 신고 및 문의 게시판에 제보해주세요.
🟢 3. 레퍼런스 (예제) 코드
레퍼런스는 https://api.lrl.kr/ref/v5/ 에서 확인하실 수 있습니다.
크롬 기준 우클릭 -> 페이지 소스 보기 를 눌러서 코드를 확인하세요.
- 다음글 도메인 목록 API - v5 22.06.19