소개
다양한 페이. SNS 링크. 간편 송금.
'하나의 QR과 URL에'
AQR 개발자를 위한 API 사용법과 예제코드를 제공합니다.
Token 발급 받기
API 사용을 위해 AQR 개발자 Token을 발급 받으세요.
AQR API는 AQR 개발자 Token을 파라메터로 입력해야 사용할 수 있습니다.
개발자 Token은 아래의 AQR 서비스에 가입 및 로그인 후 화면의 우측 상단 "개인정보수정" 메뉴에서 확인 할 수 있습니다.
AQR 서비스의 "Advanced" 등급 또는 제휴사에 한해서 개발자 Token을 제공합니다.
계좌 정보 생성/삭제
계좌 정보 생성하기
curl -H "AQR-DEVELOPER-TOKEN: <DEVELOPER TOKEN>" -H "Content-type: application/x-www-form-urlencoded" -X POST -d 'email_address=<EMAILID>&account_number=1234567894321&bank_id=1&account_owner=<OWNER NAME>&phone_number=01012341234&account_name=<ACCOUNT NAME>&action=aqr_create' https://aplx.link/api/
$body['email_address'] = '<EMAILID>';
$body['account_number'] = '1234567894321';
$body['bank_id'] = '1';
$body['account_owner'] = '<OWNER NAME>';
$body['phone_number'] = '01012341234';
$body['account_name'] = '<ACCOUNT NAME>';
$body['action'] = 'aqr_create';
$headers = array(
'Content-Type: application/x-www-form-urlencoded',
'AQR-DEVELOPER-TOKEN: <DEVELOPER TOKEN>'
);
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://aplx.link/api/');
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
curl_setopt($ch, CURLOPT_POSTFIELDS,http_build_query($body));
$response = curl_exec($ch);
//$json_list= json_decode($response, true);
curl_close($ch);
echo $response;
var formdata = new FormData();
formdata.append("email_address", "<EMAILID>");
formdata.append("account_number", "123456789432");
formdata.append("bank_id", "1");
formdata.append("account_owner", "<OWNER NAME>");
formdata.append("phone_number", "01012341234");
formdata.append("account_name", "<ACCOUNT NAME>");
formdata.append("action", "aqr_create");
$.ajax({url : "https://aplx.link/api/",
dataType : "json",
contentType : "application/x-www-form-urlencoded",
crossDomain: true,
cache : false,
data : formdata,
type : "POST",
async: false,
beforeSend: function(request) {
request.setRequestHeader("AQR-DEVELOPER-TOKEN", "<DEVELOPER TOKEN>");
},
success : function(r) {
console.log(JSON.stringify(r));
if(r.result == "success") {
//r.data
}
},
error:function(request,status,error){
alert("code:"+request.status+"\n"+"message:"+request.responseText+"\n"+"error:"+error);
}
});
import requests
headers = {
'Content-Type': 'application/x-www-form-urlencoded',
'AQR-DEVELOPER-TOKEN' : '<DEVELOPER TOKEN>'
}
data = "email_address=<EMAILID>&account_number=1234567894321&bank_id=1&account_owner=<OWNER NAME>&phone_number=01012341234&account_name=<ACCOUNT NAME>&action=aqr_create"
url = 'https://aplx.link/api/'
response = requests.post(url, headers=headers,
data=data)
response.raise_for_status()
'response.json()
var content = "email_address=" + Uri.EscapeDataString("<EMAILID>");
content += "&account_number=" + Uri.EscapeDataString("1234567894321");
content += "&bank_id=" + Uri.EscapeDataString("1");
content += "&account_owner=" + Uri.EscapeDataString("<OWNER NAME>");
content += "&phone_number=" + Uri.EscapeDataString("01012341234");
content += "&account_name=" + Uri.EscapeDataString("<ACCOUNT NAME>");
content += "&action=" + Uri.EscapeDataString("aqr_create");
var url = "https://aplx.link/api/";
byte[] data = Encoding.UTF8.GetBytes(content);
WebRequest request = WebRequest.Create(url);
request.Method = "POST";
request.ContentType = "application/json";
request.Headers.Add("Authorization", "AQR-DEVELOPER-TOKEN <DEVELOPER TOKEN>");
request.ContentLength = data.Length;
using (Stream stream = request.GetRequestStream())
{
stream.Write(data, 0, data.Length);
}
try
{
WebResponse response = await request.GetResponseAsync();
}
catch (WebException webException)
{
}
이 요청은 아래와 같이 JSON 구조로 응답합니다:
{
"result" : "success",
"qr_image" : "https://aplx.link/res?keyword=abcde", // QR 이미지 다운로드 경로
"short_url" : "https://aq.gy/f/abcde", // 계좌 정보 고유 URL
"account_id" : "abcde" // 계좌 정보 ID (삭제/수정시 사용)
}
HTTP 요청
POST https://aplx.link/api/
파라메터
| 헤더 파라메터 | 설명 |
|---|---|
| AQR-DEVELOPER-TOKEN | 부여받은 개발자 Token값을 헤더에 입력합니다. |
| POST 파라메터 | 설명 |
|---|---|
| action | "aqr_create"를 입력합니다. |
| email_address | 가입시 입력한 이메일 주소를 입력합니다. |
| account_number | 계좌 번호를 입력합니다. |
| bank_id | 은행 id 를 입력합니다. (은행 id 테이블 참조) |
| account_owner | 예금주 명을 입력합니다. |
| phone_number | 예금주의 전화번호를 입력합니다. |
| account_name | 생성할 계좌 정보의 이름을 입력합니다. |
은행 id 테이블
| id | 은행명 |
|---|---|
| 0 | 카카오뱅크 |
| 1 | 토스뱅크 |
| 2 | 케이뱅크 |
| 3 | 국민은행 |
| 4 | 기업은행 |
| 5 | 농협은행 |
| 6 | 신한은행 |
| 7 | 부산은행 |
| 8 | 우체국 |
| 9 | 새마을금고 |
| 10 | 산업은행 |
| 11 | 우리은행 |
| 12 | 하나은행 |
| 13 | 한국시티은행 |
| 14 | SC제일은행 |
| 15 | 경남은행 |
| 16 | 광주은행 |
| 17 | 대구은행 |
| 18 | 도이치은행 |
| 19 | 뱅크오브아메리카 |
| 20 | 산림조합중앙회 |
| 21 | 저축은행 |
| 22 | 수협은행 |
| 23 | 신협중앙회 |
| 24 | 전북은행 |
| 25 | 제주은행 |
| 26 | 중국건설은행 |
| 27 | 중국공상은행 |
| 28 | 중국은행 |
| 29 | BNP파리바은행 |
| 30 | HSBC은행 |
| 31 | JP모간체이스은행 |
| 32 | DB금융투자 |
| 33 | 메리츠증권 |
| 34 | 부국증권 |
| 35 | 교보증권 |
| 36 | 대신증권 |
| 37 | 현대차증권 |
| 38 | 미레에셋증권 |
| 39 | 삼성증권 |
| 40 | 신영증권 |
| 41 | 신한투자증권 |
| 42 | 에스케이증권 |
| 43 | 유안타증권 |
| 44 | 유진투자증권 |
| 45 | 이베스트투자증권 |
| 46 | 케이프투자증권 |
| 47 | 키움증권 |
| 48 | 한국포스증권 |
| 49 | 하나증권 |
| 50 | 하이투자증권 |
| 51 | 한국투자증권 |
| 52 | 한화투자증권 |
| 53 | KB증권 |
| 54 | 다올투자증권 |
| 55 | BNK투자증권 |
| 56 | NH투자증권 |
| 57 | 토스증권 |
| 58 | 카카오페이증권 |
| 59 | IBK투자증권 |
계좌 정보 삭제하기
curl -H "AQR-DEVELOPER-TOKEN: <DEVELOPER TOKEN>" -H "Content-type: application/x-www-form-urlencoded" -X POST -d 'email_address=<EMAILID>&account_id=abcde&action=aqr_delete' https://aplx.link/api/
$body['email_address'] = '<EMAILID>';
$body['account_id'] = 'abcde';
$body['action'] = 'aqr_delete';
$headers = array(
'Content-Type: application/x-www-form-urlencoded',
'AQR-DEVELOPER-TOKEN: <DEVELOPER TOKEN>'
);
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://aplx.link/api/');
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
curl_setopt($ch, CURLOPT_POSTFIELDS,http_build_query($body));
$response = curl_exec($ch);
//$json_list= json_decode($response, true);
curl_close($ch);
echo $response;
var formdata = new FormData();
formdata.append("email_address", "<EMAILID>");
formdata.append("account_id", "abcde");
formdata.append("action", "aqr_delete");
$.ajax({url : "https://aplx.link/api/",
dataType : "json",
contentType : "application/x-www-form-urlencoded",
crossDomain: true,
cache : false,
data : formdata,
type : "POST",
async: false,
beforeSend: function(request) {
request.setRequestHeader("AQR-DEVELOPER-TOKEN", "<DEVELOPER TOKEN>");
},
success : function(r) {
console.log(JSON.stringify(r));
if(r.result == "success") {
//r.data
}
},
error:function(request,status,error){
alert("code:"+request.status+"\n"+"message:"+request.responseText+"\n"+"error:"+error);
}
});
import requests
headers = {
'Content-Type': 'application/x-www-form-urlencoded',
'AQR-DEVELOPER-TOKEN' : '<DEVELOPER TOKEN>'
}
data = "email_address=<EMAILID>&account_id=abcde&action=aqr_delete"
url = 'https://aplx.link/api/'
response = requests.post(url, headers=headers,
data=data)
response.raise_for_status()
'response.json()
var content = "email_address=" + Uri.EscapeDataString("<EMAILID>");
content += "&account_id=" + Uri.EscapeDataString("abcde");
content += "&action=" + Uri.EscapeDataString("aqr_delete");
byte[] data = Encoding.UTF8.GetBytes(content);
WebRequest request = WebRequest.Create(url);
request.Method = "POST";
request.ContentType = "application/json";
request.Headers.Add("Authorization", "AQR-DEVELOPER-TOKEN <DEVELOPER TOKEN>");
request.ContentLength = data.Length;
using (Stream stream = request.GetRequestStream())
{
stream.Write(data, 0, data.Length);
}
try
{
WebResponse response = await request.GetResponseAsync();
}
catch (WebException webException)
{
}
이 요청은 아래와 같이 JSON 구조로 응답합니다:
{
"result" : "success"
}
HTTP 요청
POST https://aplx.link/api/
파라메터
| 헤더 파라메터 | 설명 |
|---|---|
| AQR-DEVELOPER-TOKEN | 부여받은 개발자 Token값을 헤더에 입력합니다. |
| POST 파라메터 | 설명 |
|---|---|
| action | "aqr_delete"를 입력합니다. |
| email_address | 가입시 입력한 이메일 주소를 입력합니다. |
| account_id | 계좌 생성시 확인한 'account_id'값을 입력합니다. |
Errors
AQR API uses the following error codes:
| Error Code | Meaning |
|---|---|
| 400 | Bad Request -- Your request is invalid. |
| 401 | Unauthorized -- Your API key is wrong. |
| 403 | Forbidden -- The API requested is hidden for administrators only. |
| 404 | Not Found -- The specified resource could not be found. |
| 405 | Method Not Allowed -- You tried to access a resource with an invalid method. |
| 406 | Not Acceptable -- You requested a format that isn't json. |
| 410 | Gone -- The resource requested has been removed from our servers. |
| 429 | Too Many Requests -- You're requesting too many resource! Slow down! |
| 500 | Internal Server Error -- We had a problem with our server. Try again later. |
| 503 | Service Unavailable -- We're temporarily offline for maintenance. Please try again later. |