개발자를 위한 API 레퍼런스

시작

시스템에서 요청을 처리하려면 API 키가 필요합니다. 사용자가 등록하면 이 사용자에 대한 API 키가 자동으로 생성됩니다. API 키는 각 요청과 함께 전송되어야 합니다(아래 전체 예 참조). API 키가 전송되지 않거나 만료된 경우 오류가 발생합니다. 남용을 방지하기 위해 API 키를 비밀로 유지하세요.

인증

API 시스템으로 인증하려면 각 요청과 함께 API 키를 인증 토큰으로 보내야 합니다. 아래에서 샘플 코드를 볼 수 있습니다.

curl --location --request POST 'https://urlkai.com/api/account' \
--header '권한 부여: 전달자 YOURAPIKEY' \
--헤더 'Content-Type: application/json' \ 
$curl = curl_init();
curl_setopt_array($curl, 배열(
    CURLOPT_URL => "https://urlkai.com/api/account",
    CURLOPT_RETURNTRANSFER => 참,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => 참,
    CURLOPT_CUSTOMREQUEST => "게시",
    CURLOPT_HTTPHEADER => [
        "권한 부여: 베어러 YOURAPIKEY",
        "콘텐츠 유형: application/json",
    ],
));

$response = curl_exec($curl); 
var 요청 = require('요청');
var 옵션 = {
    '메서드': '게시',
    'url': 'https://urlkai.com/api/account',
    '헤더': {
        'Authorization': '무기명 YOURAPIKEY',
        '콘텐츠 유형': '애플리케이션/json'
    },
    본문: ''
};
요청(옵션, 함수(오류, 응답) {
    if (error) throw new Error(error);
    console.log(응답.본문);
}); 
가져오기 요청
url = "https://urlkai.com/api/account"
페이로드 = {}
헤더 = {
  'Authorization': '무기명 YOURAPIKEY',
  '콘텐츠 유형': '애플리케이션/json'
}
응답 = requests.request("GET", url, headers=headers, json=payload)
인쇄(응답.텍스트) 
var 클라이언트 = 새로운 HttpClient ();
var 요청 = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/account");
요청. Headers.Add("권한 부여", "전달자 YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
요청. 콘텐츠 = 콘텐츠;
var 응답 = await client. SendAsync (요청);
응답. EnsureSuccessStatusCode();
Console.WriteLine(응답을 기다립니다. Content.ReadAsStringAsync()); 
속도 제한

API에는 안정성을 극대화하기 위해 요청 급증을 방지하는 속도 제한기가 있습니다. 속도 제한기는 현재 1분당 30개의 요청으로 제한됩니다. 요금은 가입한 플랜에 따라 변경될 수 있습니다.

응답과 함께 여러 헤더가 전송되며 이를 검사하여 요청에 대한 다양한 정보를 확인할 수 있습니다.

X-RateLimit-Limit: 30
X-RateLimit-Remaining: 29
X-RateLimit-Reset: TIMESTAMP
응답 처리

모든 API 응답은 기본적으로 JSON 형식으로 반환됩니다. 이를 사용 가능한 데이터로 변환하려면 언어에 따라 적절한 함수를 사용해야 합니다. PHP에서 json_decode() 함수를 사용하여 데이터를 객체(기본값) 또는 배열(두 번째 매개변수를 true로 설정)로 변환할 수 있습니다. 오류가 있는지 여부에 대한 정보를 제공하는 오류 키를 확인하는 것이 매우 중요합니다. 헤더 코드도 확인할 수 있습니다.

{
    "error": 1,
    "message": "An error occurred"
}

계좌

계정 가져오기
GET https://urlkai.com/api/account

계정에 대한 정보를 얻으려면 이 엔드포인트에 요청을 보낼 수 있으며 계정에 대한 데이터가 반환됩니다.

curl --location --request GET 'https://urlkai.com/api/account' \
--header '권한 부여: 전달자 YOURAPIKEY' \
--헤더 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, 배열(
    CURLOPT_URL => "https://urlkai.com/api/account",
    CURLOPT_RETURNTRANSFER => 참,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => 참,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "권한 부여: 베어러 YOURAPIKEY",
        "콘텐츠 유형: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
에코 $response; 
var 요청 = require('요청');
var 옵션 = {
    '메서드': 'GET',
    'url': 'https://urlkai.com/api/account',
    '헤더': {
        'Authorization': '무기명 YOURAPIKEY',
        '콘텐츠 유형': '애플리케이션/json'
    },
    
};
요청(옵션, 함수(오류, 응답) {
    if (error) throw new Error(error);
    console.log(응답.본문);
}); 
가져오기 요청
url = "https://urlkai.com/api/account"
페이로드 = {}
헤더 = {
    'Authorization': '무기명 YOURAPIKEY',
    '콘텐츠 유형': '애플리케이션/json'
}
응답 = requests.request("GET", url, headers=headers, json=payload)
인쇄(응답.텍스트) 
var 클라이언트 = 새로운 HttpClient ();
var 요청 = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/account");
요청. Headers.Add("권한 부여", "전달자 YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
요청. 콘텐츠 = 콘텐츠;
var 응답 = await client. SendAsync (요청);
응답. EnsureSuccessStatusCode();
Console.WriteLine(응답을 기다립니다. Content.ReadAsStringAsync()); 
서버 응답
{
    "오류": 0,
    "데이터": {
        "아이디": 1,
        "이메일": " [이메일 보호] ",
        "사용자 이름": "샘플 사용자",
        "avatar": "https:\/\/domain.com/content\/avatar.png",
        "상태": "프로",
        "만료": "2022-11-15 15:00:00",
        "등록됨": "2020-11-10 18:01:43"
    }
} 
계정 업데이트
PUT https://urlkai.com/api/account/update

계정에 대한 정보를 업데이트하기 위해 이 엔드포인트에 요청을 보낼 수 있으며 이 엔드포인트는 계정의 데이터를 업데이트합니다.

curl --location --request PUT 'https://urlkai.com/api/account/update' \
--header '권한 부여: 전달자 YOURAPIKEY' \
--헤더 'Content-Type: application/json' \
--데이터 원시 '{
    "이메일": " [이메일 보호] ",
    "비밀번호": "새 비밀번호"
}' 
$curl = curl_init();

curl_setopt_array($curl, 배열(
    CURLOPT_URL => "https://urlkai.com/api/account/update",
    CURLOPT_RETURNTRANSFER => 참,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => 참,
    CURLOPT_CUSTOMREQUEST => "놓다",
    CURLOPT_HTTPHEADER => [
        "권한 부여: 베어러 YOURAPIKEY",
        "콘텐츠 유형: application/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "이메일": " [이메일 보호] ",
	    "비밀번호": "새 비밀번호"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
에코 $response; 
var 요청 = require('요청');
var 옵션 = {
    '메소드': '풋',
    'url': 'https://urlkai.com/api/account/update',
    '헤더': {
        'Authorization': '무기명 YOURAPIKEY',
        '콘텐츠 유형': '애플리케이션/json'
    },
    본문 : JSON.stringify ({
    "이메일": " [이메일 보호] ",
    "비밀번호": "새 비밀번호"
}),
};
요청(옵션, 함수(오류, 응답) {
    if (error) throw new Error(error);
    console.log(응답.본문);
}); 
가져오기 요청
url = "https://urlkai.com/api/account/update"
페이로드 = {
    "이메일": " [이메일 보호] ",
    "비밀번호": "새 비밀번호"
}
헤더 = {
    'Authorization': '무기명 YOURAPIKEY',
    '콘텐츠 유형': '애플리케이션/json'
}
응답 = requests.request("PUT", url, headers=headers, json=payload)
인쇄(응답.텍스트) 
var 클라이언트 = 새로운 HttpClient ();
var 요청 = new HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/account/update");
요청. Headers.Add("권한 부여", "전달자 YOURAPIKEY");
var 내용 = new StringContent("{
    "이메일": " [이메일 보호] ",
    "비밀번호": "새 비밀번호"
}", System.Text.Encoding.UTF8, "응용 프로그램/json");
요청. 콘텐츠 = 콘텐츠;
var 응답 = await client. SendAsync (요청);
응답. EnsureSuccessStatusCode();
Console.WriteLine(응답을 기다립니다. Content.ReadAsStringAsync()); 
서버 응답
{
    "오류": 0,
    "message": "계정이 성공적으로 업데이트되었습니다."
} 

브랜드 도메인

브랜드 도메인 나열
GET https://urlkai.com/api/domains?limit=2&page=1

API를 통해 브랜드 도메인을 가져오려면 이 엔드포인트를 사용할 수 있습니다. 데이터를 필터링할 수도 있습니다(자세한 내용은 표 참조).

매개 변수 묘사
한계 (선택 사항) 페이지별 데이터 결과
페이지 (선택 사항) 현재 페이지 요청
curl --location --request GET 'https://urlkai.com/api/domains?limit=2&page=1' \
--header '권한 부여: 전달자 YOURAPIKEY' \
--헤더 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, 배열(
    CURLOPT_URL => "https://urlkai.com/api/domains?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => 참,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => 참,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "권한 부여: 베어러 YOURAPIKEY",
        "콘텐츠 유형: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
에코 $response; 
var 요청 = require('요청');
var 옵션 = {
    '메서드': 'GET',
    'url': 'https://urlkai.com/api/domains?limit=2&page=1',
    '헤더': {
        'Authorization': '무기명 YOURAPIKEY',
        '콘텐츠 유형': '애플리케이션/json'
    },
    
};
요청(옵션, 함수(오류, 응답) {
    if (error) throw new Error(error);
    console.log(응답.본문);
}); 
가져오기 요청
url = "https://urlkai.com/api/domains?limit=2&page=1"
페이로드 = {}
헤더 = {
    'Authorization': '무기명 YOURAPIKEY',
    '콘텐츠 유형': '애플리케이션/json'
}
응답 = requests.request("GET", url, headers=headers, json=payload)
인쇄(응답.텍스트) 
var 클라이언트 = 새로운 HttpClient ();
var 요청 = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/domains?limit=2&page=1");
요청. Headers.Add("권한 부여", "전달자 YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
요청. 콘텐츠 = 콘텐츠;
var 응답 = await client. SendAsync (요청);
응답. EnsureSuccessStatusCode();
Console.WriteLine(응답을 기다립니다. Content.ReadAsStringAsync()); 
서버 응답
{
    "오류": "0",
    "데이터": {
        "결과": 2,
        "퍼페이지": 2,
        "현재 페이지": 1,
        "다음 페이지": 1,
        "최대 페이지": 1,
        "도메인": [
            {
                "아이디": 1,
                "domain": "https:\/\/domain1.com",
                "redirectroot": "https:\/\/rootdomain.com",
                "redirect404": "https:\/\/rootdomain.com\/404"
            },
            {
                "아이디": 2,
                "domain": "https:\/\/domain2.com",
                "redirectroot": "https:\/\/rootdomain2.com",
                "redirect404": "https:\/\/rootdomain2.com\/404"
            }
        ]
    }
} 
브랜드 도메인 만들기
POST https://urlkai.com/api/domain/add

이 엔드포인트를 사용하여 도메인을 추가할 수 있습니다. 도메인이 당사 서버를 올바르게 가리키고 있는지 확인하십시오.

매개 변수 묘사
도메인 (필수) http 또는 https를 포함한 브랜드 도메인
리다이렉터루트 (선택 사항) 누군가 도메인을 방문할 때 루트 리디렉션
리디렉션404 (선택 사항) 사용자 지정 404 리디렉션
curl --location --POST 'https://urlkai.com/api/domain/add' 요청 \
--header '권한 부여: 전달자 YOURAPIKEY' \
--헤더 'Content-Type: application/json' \
--데이터 원시 '{
    "domain": "https:\/\/domain1.com",
    "redirectroot": "https:\/\/rootdomain.com",
    "redirect404": "https:\/\/rootdomain.com\/404"
}' 
$curl = curl_init();

curl_setopt_array($curl, 배열(
    CURLOPT_URL => "https://urlkai.com/api/domain/add",
    CURLOPT_RETURNTRANSFER => 참,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => 참,
    CURLOPT_CUSTOMREQUEST => "게시",
    CURLOPT_HTTPHEADER => [
        "권한 부여: 베어러 YOURAPIKEY",
        "콘텐츠 유형: application/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "domain": "https:\/\/domain1.com",
	    "redirectroot": "https:\/\/rootdomain.com",
	    "redirect404": "https:\/\/rootdomain.com\/404"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
에코 $response; 
var 요청 = require('요청');
var 옵션 = {
    '메서드': '게시',
    'url': 'https://urlkai.com/api/domain/add',
    '헤더': {
        'Authorization': '무기명 YOURAPIKEY',
        '콘텐츠 유형': '애플리케이션/json'
    },
    본문 : JSON.stringify ({
    "domain": "https:\/\/domain1.com",
    "redirectroot": "https:\/\/rootdomain.com",
    "redirect404": "https:\/\/rootdomain.com\/404"
}),
};
요청(옵션, 함수(오류, 응답) {
    if (error) throw new Error(error);
    console.log(응답.본문);
}); 
가져오기 요청
url = "https://urlkai.com/api/domain/add"
페이로드 = {
    "도메인": "https://domain1.com",
    "리다이렉트루트": "https://rootdomain.com",
    "redirect404": "https://rootdomain.com/404"
}
헤더 = {
    'Authorization': '무기명 YOURAPIKEY',
    '콘텐츠 유형': '애플리케이션/json'
}
응답 = requests.request("POST", url, headers=headers, json=payload)
인쇄(응답.텍스트) 
var 클라이언트 = 새로운 HttpClient ();
var 요청 = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/domain/add");
요청. Headers.Add("권한 부여", "전달자 YOURAPIKEY");
var 내용 = new StringContent("{
    "domain": "https:\/\/domain1.com",
    "redirectroot": "https:\/\/rootdomain.com",
    "redirect404": "https:\/\/rootdomain.com\/404"
}", System.Text.Encoding.UTF8, "응용 프로그램/json");
요청. 콘텐츠 = 콘텐츠;
var 응답 = await client. SendAsync (요청);
응답. EnsureSuccessStatusCode();
Console.WriteLine(응답을 기다립니다. Content.ReadAsStringAsync()); 
서버 응답
{
    "오류": 0,
    "아이디": 1
} 
도메인 업데이트
PUT https://urlkai.com/api/domain/:id/update

브랜드 도메인을 업데이트하려면 PUT 요청을 통해 JSON으로 유효한 데이터를 보내야 합니다. 데이터는 아래와 같이 요청의 원시 본문으로 전송되어야 합니다. 아래 예제에서는 보낼 수 있는 모든 매개 변수를 보여 주지만 모두 보낼 필요는 없습니다(자세한 내용은 표 참조).

매개 변수 묘사
리다이렉터루트 (선택 사항) 누군가 도메인을 방문할 때 루트 리디렉션
리디렉션404 (선택 사항) 사용자 지정 404 리디렉션
curl --location --request PUT 'https://urlkai.com/api/domain/:id/update' \
--header '권한 부여: 전달자 YOURAPIKEY' \
--헤더 'Content-Type: application/json' \
--데이터 원시 '{
    "redirectroot": "https:\/\/rootdomain-new.com",
    "redirect404": "https:\/\/rootdomain-new.com\/404"
}' 
$curl = curl_init();

curl_setopt_array($curl, 배열(
    CURLOPT_URL => "https://urlkai.com/api/domain/:id/update",
    CURLOPT_RETURNTRANSFER => 참,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => 참,
    CURLOPT_CUSTOMREQUEST => "놓다",
    CURLOPT_HTTPHEADER => [
        "권한 부여: 베어러 YOURAPIKEY",
        "콘텐츠 유형: application/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "redirectroot": "https:\/\/rootdomain-new.com",
	    "redirect404": "https:\/\/rootdomain-new.com\/404"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
에코 $response; 
var 요청 = require('요청');
var 옵션 = {
    '메소드': '풋',
    'url': 'https://urlkai.com/api/domain/:id/update',
    '헤더': {
        'Authorization': '무기명 YOURAPIKEY',
        '콘텐츠 유형': '애플리케이션/json'
    },
    본문 : JSON.stringify ({
    "redirectroot": "https:\/\/rootdomain-new.com",
    "redirect404": "https:\/\/rootdomain-new.com\/404"
}),
};
요청(옵션, 함수(오류, 응답) {
    if (error) throw new Error(error);
    console.log(응답.본문);
}); 
가져오기 요청
url = "https://urlkai.com/api/domain/:id/update"
페이로드 = {
    "리다이렉트 루트": "https://rootdomain-new.com",
    "redirect404": "https://rootdomain-new.com/404"
}
헤더 = {
    'Authorization': '무기명 YOURAPIKEY',
    '콘텐츠 유형': '애플리케이션/json'
}
응답 = requests.request("PUT", url, headers=headers, json=payload)
인쇄(응답.텍스트) 
var 클라이언트 = 새로운 HttpClient ();
var 요청 = new HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/domain/:id/update");
요청. Headers.Add("권한 부여", "전달자 YOURAPIKEY");
var 내용 = new StringContent("{
    "redirectroot": "https:\/\/rootdomain-new.com",
    "redirect404": "https:\/\/rootdomain-new.com\/404"
}", System.Text.Encoding.UTF8, "응용 프로그램/json");
요청. 콘텐츠 = 콘텐츠;
var 응답 = await client. SendAsync (요청);
응답. EnsureSuccessStatusCode();
Console.WriteLine(응답을 기다립니다. Content.ReadAsStringAsync()); 
서버 응답
{
    "오류": 0,
    "message": "도메인이 성공적으로 업데이트되었습니다."
} 
도메인 삭제
DELETE https://urlkai.com/api/domain/:id/delete

도메인을 삭제하려면 DELETE 요청을 보내야 합니다.

curl --location --request DELETE 'https://urlkai.com/api/domain/:id/delete' \
--header '권한 부여: 전달자 YOURAPIKEY' \
--헤더 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, 배열(
    CURLOPT_URL => "https://urlkai.com/api/domain/:id/delete",
    CURLOPT_RETURNTRANSFER => 참,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => 참,
    CURLOPT_CUSTOMREQUEST => "삭제",
    CURLOPT_HTTPHEADER => [
        "권한 부여: 베어러 YOURAPIKEY",
        "콘텐츠 유형: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
에코 $response; 
var 요청 = require('요청');
var 옵션 = {
    '메소드': '삭제',
    'url': 'https://urlkai.com/api/domain/:id/delete',
    '헤더': {
        'Authorization': '무기명 YOURAPIKEY',
        '콘텐츠 유형': '애플리케이션/json'
    },
    
};
요청(옵션, 함수(오류, 응답) {
    if (error) throw new Error(error);
    console.log(응답.본문);
}); 
가져오기 요청
url = "https://urlkai.com/api/domain/:id/delete"
페이로드 = {}
헤더 = {
    'Authorization': '무기명 YOURAPIKEY',
    '콘텐츠 유형': '애플리케이션/json'
}
응답 = requests.request("삭제", url, headers=headers, json=payload)
인쇄(응답.텍스트) 
var 클라이언트 = 새로운 HttpClient ();
var 요청 = new HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/domain/:id/delete");
요청. Headers.Add("권한 부여", "전달자 YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
요청. 콘텐츠 = 콘텐츠;
var 응답 = await client. SendAsync (요청);
응답. EnsureSuccessStatusCode();
Console.WriteLine(응답을 기다립니다. Content.ReadAsStringAsync()); 
서버 응답
{
    "오류": 0,
    "message": "도메인이 성공적으로 삭제되었습니다."
} 

CTA 오버레이

CTA 오버레이 나열
GET https://urlkai.com/api/overlay?limit=2&page=1

API를 통해 cta 오버레이를 가져오려면 이 엔드포인트를 사용할 수 있습니다. 데이터를 필터링할 수도 있습니다(자세한 내용은 표 참조).

매개 변수 묘사
한계 (선택 사항) 페이지별 데이터 결과
페이지 (선택 사항) 현재 페이지 요청
curl --location --request GET 'https://urlkai.com/api/overlay?limit=2&page=1' \
--header '권한 부여: 전달자 YOURAPIKEY' \
--헤더 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, 배열(
    CURLOPT_URL => "https://urlkai.com/api/overlay?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => 참,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => 참,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "권한 부여: 베어러 YOURAPIKEY",
        "콘텐츠 유형: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
에코 $response; 
var 요청 = require('요청');
var 옵션 = {
    '메서드': 'GET',
    'url': 'https://urlkai.com/api/overlay?limit=2&page=1',
    '헤더': {
        'Authorization': '무기명 YOURAPIKEY',
        '콘텐츠 유형': '애플리케이션/json'
    },
    
};
요청(옵션, 함수(오류, 응답) {
    if (error) throw new Error(error);
    console.log(응답.본문);
}); 
가져오기 요청
url = "https://urlkai.com/api/overlay?limit=2&page=1"
페이로드 = {}
헤더 = {
    'Authorization': '무기명 YOURAPIKEY',
    '콘텐츠 유형': '애플리케이션/json'
}
응답 = requests.request("GET", url, headers=headers, json=payload)
인쇄(응답.텍스트) 
var 클라이언트 = 새로운 HttpClient ();
var 요청 = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/overlay?limit=2&page=1");
요청. Headers.Add("권한 부여", "전달자 YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
요청. 콘텐츠 = 콘텐츠;
var 응답 = await client. SendAsync (요청);
응답. EnsureSuccessStatusCode();
Console.WriteLine(응답을 기다립니다. Content.ReadAsStringAsync()); 
서버 응답
{
    "오류": "0",
    "데이터": {
        "결과": 2,
        "퍼페이지": 2,
        "현재 페이지": 1,
        "다음 페이지": 1,
        "최대 페이지": 1,
        "CTA": [
            {
                "아이디": 1,
                "type": "메시지",
                "name": "제품 1 프로모션",
                "date": "2020-11-10 18:00:00"
            },
            {
                "아이디": 2,
                "type": "연락처",
                "name": "연락처 페이지",
                "날짜": "2020-11-10 18:10:00"
            }
        ]
    }
} 

캠페인

캠페인 나열
GET https://urlkai.com/api/campaigns?limit=2&page=1

API를 통해 캠페인을 가져오려면 이 엔드포인트를 사용할 수 있습니다. 데이터를 필터링할 수도 있습니다(자세한 내용은 표 참조).

매개 변수 묘사
한계 (선택 사항) 페이지별 데이터 결과
페이지 (선택 사항) 현재 페이지 요청
curl --location --request GET 'https://urlkai.com/api/campaigns?limit=2&page=1' \
--header '권한 부여: 전달자 YOURAPIKEY' \
--헤더 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, 배열(
    CURLOPT_URL => "https://urlkai.com/api/campaigns?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => 참,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => 참,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "권한 부여: 베어러 YOURAPIKEY",
        "콘텐츠 유형: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
에코 $response; 
var 요청 = require('요청');
var 옵션 = {
    '메서드': 'GET',
    'url': 'https://urlkai.com/api/campaigns?limit=2&page=1',
    '헤더': {
        'Authorization': '무기명 YOURAPIKEY',
        '콘텐츠 유형': '애플리케이션/json'
    },
    
};
요청(옵션, 함수(오류, 응답) {
    if (error) throw new Error(error);
    console.log(응답.본문);
}); 
가져오기 요청
url = "https://urlkai.com/api/campaigns?limit=2&page=1"
페이로드 = {}
헤더 = {
    'Authorization': '무기명 YOURAPIKEY',
    '콘텐츠 유형': '애플리케이션/json'
}
응답 = requests.request("GET", url, headers=headers, json=payload)
인쇄(응답.텍스트) 
var 클라이언트 = 새로운 HttpClient ();
var 요청 = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/campaigns?limit=2&page=1");
요청. Headers.Add("권한 부여", "전달자 YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
요청. 콘텐츠 = 콘텐츠;
var 응답 = await client. SendAsync (요청);
응답. EnsureSuccessStatusCode();
Console.WriteLine(응답을 기다립니다. Content.ReadAsStringAsync()); 
서버 응답
{
    "오류": "0",
    "데이터": {
        "결과": 2,
        "퍼페이지": 2,
        "현재 페이지": 1,
        "다음 페이지": 1,
        "최대 페이지": 1,
        "캠페인": [
            {
                "아이디": 1,
                "name": "샘플 캠페인",
                "공개": 거짓,
                "로테이터": 거짓,
                "list": "https:\/\/domain.com\/u\/admin\/list-1"
            },
            {
                "아이디": 2,
                "domain": "페이스북 캠페인",
                "공개": 사실,
                "rotator": "https:\/\/domain.com\/r\/test",
                "list": "https:\/\/domain.com\/u\/admin\/test-2"
            }
        ]
    }
} 
캠페인 만들기
POST https://urlkai.com/api/campaign/add

이 엔드포인트를 사용하여 캠페인을 추가할 수 있습니다.

매개 변수 묘사
이름 (선택 사항) 캠페인 이름
민달팽이 (선택 사항) 로테이터 슬러그
공공의 (선택 사항) 접근
curl --location --request POST 'https://urlkai.com/api/campaign/add' \
--header '권한 부여: 전달자 YOURAPIKEY' \
--헤더 'Content-Type: application/json' \
--데이터 원시 '{
    "name": "새 캠페인",
    "slug": "새 캠페인",
    "공개": 참
}' 
$curl = curl_init();

curl_setopt_array($curl, 배열(
    CURLOPT_URL => "https://urlkai.com/api/campaign/add",
    CURLOPT_RETURNTRANSFER => 참,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => 참,
    CURLOPT_CUSTOMREQUEST => "게시",
    CURLOPT_HTTPHEADER => [
        "권한 부여: 베어러 YOURAPIKEY",
        "콘텐츠 유형: application/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "name": "새 캠페인",
	    "slug": "새 캠페인",
	    "공개": 참
	}',
));

$response = curl_exec($curl);

curl_close($curl);
에코 $response; 
var 요청 = require('요청');
var 옵션 = {
    '메서드': '게시',
    'url': 'https://urlkai.com/api/campaign/add',
    '헤더': {
        'Authorization': '무기명 YOURAPIKEY',
        '콘텐츠 유형': '애플리케이션/json'
    },
    본문 : JSON.stringify ({
    "name": "새 캠페인",
    "slug": "새 캠페인",
    "공개": 참
}),
};
요청(옵션, 함수(오류, 응답) {
    if (error) throw new Error(error);
    console.log(응답.본문);
}); 
가져오기 요청
url = "https://urlkai.com/api/campaign/add"
페이로드 = {
    "name": "새 캠페인",
    "slug": "새 캠페인",
    "공개": 참
}
헤더 = {
    'Authorization': '무기명 YOURAPIKEY',
    '콘텐츠 유형': '애플리케이션/json'
}
응답 = requests.request("POST", url, headers=headers, json=payload)
인쇄(응답.텍스트) 
var 클라이언트 = 새로운 HttpClient ();
var 요청 = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/campaign/add");
요청. Headers.Add("권한 부여", "전달자 YOURAPIKEY");
var 내용 = new StringContent("{
    "name": "새 캠페인",
    "slug": "새 캠페인",
    "공개": 참
}", System.Text.Encoding.UTF8, "응용 프로그램/json");
요청. 콘텐츠 = 콘텐츠;
var 응답 = await client. SendAsync (요청);
응답. EnsureSuccessStatusCode();
Console.WriteLine(응답을 기다립니다. Content.ReadAsStringAsync()); 
서버 응답
{
    "오류": 0,
    "아이디": 3,
    "domain": "새 캠페인",
    "공개": 사실,
    "rotator": "https:\/\/domain.com\/r\/new-campaign",
    "list": "https:\/\/domain.com\/u\/admin\/new-campaign-3"
} 
POST https://urlkai.com/api/campaign/:campaignid/assign/:linkid

이 엔드포인트를 사용하여 캠페인에 짧은 링크를 할당할 수 있습니다. 엔드포인트에는 캠페인 ID와 단축 링크 ID가 필요합니다.

curl --location --request POST 'https://urlkai.com/api/campaign/:campaignid/assign/:linkid' \
--header '권한 부여: 전달자 YOURAPIKEY' \
--헤더 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, 배열(
    CURLOPT_URL => "https://urlkai.com/api/campaign/:campaignid/assign/:linkid",
    CURLOPT_RETURNTRANSFER => 참,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => 참,
    CURLOPT_CUSTOMREQUEST => "게시",
    CURLOPT_HTTPHEADER => [
        "권한 부여: 베어러 YOURAPIKEY",
        "콘텐츠 유형: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
에코 $response; 
var 요청 = require('요청');
var 옵션 = {
    '메서드': '게시',
    'url': 'https://urlkai.com/api/campaign/:campaignid/assign/:linkid',
    '헤더': {
        'Authorization': '무기명 YOURAPIKEY',
        '콘텐츠 유형': '애플리케이션/json'
    },
    
};
요청(옵션, 함수(오류, 응답) {
    if (error) throw new Error(error);
    console.log(응답.본문);
}); 
가져오기 요청
url = "https://urlkai.com/api/campaign/:campaignid/assign/:linkid"
페이로드 = {}
헤더 = {
    'Authorization': '무기명 YOURAPIKEY',
    '콘텐츠 유형': '애플리케이션/json'
}
응답 = requests.request("POST", url, headers=headers, json=payload)
인쇄(응답.텍스트) 
var 클라이언트 = 새로운 HttpClient ();
var 요청 = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/campaign/:campaignid/assign/:linkid");
요청. Headers.Add("권한 부여", "전달자 YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
요청. 콘텐츠 = 콘텐츠;
var 응답 = await client. SendAsync (요청);
응답. EnsureSuccessStatusCode();
Console.WriteLine(응답을 기다립니다. Content.ReadAsStringAsync()); 
서버 응답
{
    "오류": 0,
    "message": "링크가 캠페인에 성공적으로 추가되었습니다."
} 
캠페인 업데이트
PUT https://urlkai.com/api/campaign/:id/update

캠페인을 업데이트하려면 PUT 요청을 통해 JSON으로 유효한 데이터를 보내야 합니다. 데이터는 아래와 같이 요청의 원시 본문으로 전송되어야 합니다. 아래 예제에서는 보낼 수 있는 모든 매개 변수를 보여 주지만 모두 보낼 필요는 없습니다(자세한 내용은 표 참조).

매개 변수 묘사
이름 (필수) 캠페인 이름
민달팽이 (선택 사항) 로테이터 슬러그
공공의 (선택 사항) 접근
curl --location --request PUT 'https://urlkai.com/api/campaign/:id/update' \
--header '권한 부여: 전달자 YOURAPIKEY' \
--헤더 'Content-Type: application/json' \
--데이터 원시 '{
    "name": "트위터 캠페인",
    "slug": "트위터 캠페인",
    "공개": 참
}' 
$curl = curl_init();

curl_setopt_array($curl, 배열(
    CURLOPT_URL => "https://urlkai.com/api/campaign/:id/update",
    CURLOPT_RETURNTRANSFER => 참,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => 참,
    CURLOPT_CUSTOMREQUEST => "놓다",
    CURLOPT_HTTPHEADER => [
        "권한 부여: 베어러 YOURAPIKEY",
        "콘텐츠 유형: application/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "name": "트위터 캠페인",
	    "slug": "트위터 캠페인",
	    "공개": 참
	}',
));

$response = curl_exec($curl);

curl_close($curl);
에코 $response; 
var 요청 = require('요청');
var 옵션 = {
    '메소드': '풋',
    'url': 'https://urlkai.com/api/campaign/:id/update',
    '헤더': {
        'Authorization': '무기명 YOURAPIKEY',
        '콘텐츠 유형': '애플리케이션/json'
    },
    본문 : JSON.stringify ({
    "name": "트위터 캠페인",
    "slug": "트위터 캠페인",
    "공개": 참
}),
};
요청(옵션, 함수(오류, 응답) {
    if (error) throw new Error(error);
    console.log(응답.본문);
}); 
가져오기 요청
url = "https://urlkai.com/api/campaign/:id/update"
페이로드 = {
    "name": "트위터 캠페인",
    "slug": "트위터 캠페인",
    "공개": 참
}
헤더 = {
    'Authorization': '무기명 YOURAPIKEY',
    '콘텐츠 유형': '애플리케이션/json'
}
응답 = requests.request("PUT", url, headers=headers, json=payload)
인쇄(응답.텍스트) 
var 클라이언트 = 새로운 HttpClient ();
var 요청 = new HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/campaign/:id/update");
요청. Headers.Add("권한 부여", "전달자 YOURAPIKEY");
var 내용 = new StringContent("{
    "name": "트위터 캠페인",
    "slug": "트위터 캠페인",
    "공개": 참
}", System.Text.Encoding.UTF8, "응용 프로그램/json");
요청. 콘텐츠 = 콘텐츠;
var 응답 = await client. SendAsync (요청);
응답. EnsureSuccessStatusCode();
Console.WriteLine(응답을 기다립니다. Content.ReadAsStringAsync()); 
서버 응답
{
    "오류": 0,
    "아이디": 3,
    "domain": "트위터 캠페인",
    "공개": 사실,
    "rotator": "https:\/\/domain.com\/r\/twitter-campaign",
    "list": "https:\/\/domain.com\/u\/admin\/twitter-campaign-3"
} 
캠페인 삭제
DELETE https://urlkai.com/api/campaign/:id/delete

캠페인을 삭제하려면 DELETE 요청을 보내야 합니다.

curl --location --request DELETE 'https://urlkai.com/api/campaign/:id/delete' \
--header '권한 부여: 전달자 YOURAPIKEY' \
--헤더 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, 배열(
    CURLOPT_URL => "https://urlkai.com/api/campaign/:id/delete",
    CURLOPT_RETURNTRANSFER => 참,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => 참,
    CURLOPT_CUSTOMREQUEST => "삭제",
    CURLOPT_HTTPHEADER => [
        "권한 부여: 베어러 YOURAPIKEY",
        "콘텐츠 유형: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
에코 $response; 
var 요청 = require('요청');
var 옵션 = {
    '메소드': '삭제',
    'url': 'https://urlkai.com/api/campaign/:id/delete',
    '헤더': {
        'Authorization': '무기명 YOURAPIKEY',
        '콘텐츠 유형': '애플리케이션/json'
    },
    
};
요청(옵션, 함수(오류, 응답) {
    if (error) throw new Error(error);
    console.log(응답.본문);
}); 
가져오기 요청
url = "https://urlkai.com/api/campaign/:id/delete"
페이로드 = {}
헤더 = {
    'Authorization': '무기명 YOURAPIKEY',
    '콘텐츠 유형': '애플리케이션/json'
}
응답 = requests.request("삭제", url, headers=headers, json=payload)
인쇄(응답.텍스트) 
var 클라이언트 = 새로운 HttpClient ();
var 요청 = new HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/campaign/:id/delete");
요청. Headers.Add("권한 부여", "전달자 YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
요청. 콘텐츠 = 콘텐츠;
var 응답 = await client. SendAsync (요청);
응답. EnsureSuccessStatusCode();
Console.WriteLine(응답을 기다립니다. Content.ReadAsStringAsync()); 
서버 응답
{
    "오류": 0,
    "message": "캠페인이 성공적으로 삭제되었습니다."
} 

채널

채널 나열
GET https://urlkai.com/api/channels?limit=2&page=1

API를 통해 채널을 가져오려면 이 엔드포인트를 사용할 수 있습니다. 데이터를 필터링할 수도 있습니다(자세한 내용은 표 참조).

매개 변수 묘사
한계 (선택 사항) 페이지별 데이터 결과
페이지 (선택 사항) 현재 페이지 요청
curl --location --request GET 'https://urlkai.com/api/channels?limit=2&page=1' \
--header '권한 부여: 전달자 YOURAPIKEY' \
--헤더 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, 배열(
    CURLOPT_URL => "https://urlkai.com/api/channels?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => 참,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => 참,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "권한 부여: 베어러 YOURAPIKEY",
        "콘텐츠 유형: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
에코 $response; 
var 요청 = require('요청');
var 옵션 = {
    '메서드': 'GET',
    'url': 'https://urlkai.com/api/channels?limit=2&page=1',
    '헤더': {
        'Authorization': '무기명 YOURAPIKEY',
        '콘텐츠 유형': '애플리케이션/json'
    },
    
};
요청(옵션, 함수(오류, 응답) {
    if (error) throw new Error(error);
    console.log(응답.본문);
}); 
가져오기 요청
url = "https://urlkai.com/api/channels?limit=2&page=1"
페이로드 = {}
헤더 = {
    'Authorization': '무기명 YOURAPIKEY',
    '콘텐츠 유형': '애플리케이션/json'
}
응답 = requests.request("GET", url, headers=headers, json=payload)
인쇄(응답.텍스트) 
var 클라이언트 = 새로운 HttpClient ();
var 요청 = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/channels?limit=2&page=1");
요청. Headers.Add("권한 부여", "전달자 YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
요청. 콘텐츠 = 콘텐츠;
var 응답 = await client. SendAsync (요청);
응답. EnsureSuccessStatusCode();
Console.WriteLine(응답을 기다립니다. Content.ReadAsStringAsync()); 
서버 응답
{
    "오류": "0",
    "데이터": {
        "결과": 2,
        "퍼페이지": 2,
        "현재 페이지": 1,
        "다음 페이지": 1,
        "최대 페이지": 1,
        "채널": [
            {
                "아이디": 1,
                "name": "채널 1",
                "description": "채널 1에 대한 설명",
                "색상": "#000000",
                "별표 표시": 참
            },
            {
                "아이디": 2,
                "name": "채널 2",
                "description": "채널 2에 대한 설명",
                "색상": "#FF0000",
                "별표 표시": 거짓
            }
        ]
    }
} 
채널 항목 나열
GET https://urlkai.com/api/channel/:id?limit=1&page=1

API를 통해 선택한 채널의 항목을 가져오려면 이 엔드포인트를 사용할 수 있습니다. 데이터를 필터링할 수도 있습니다(자세한 내용은 표 참조).

매개 변수 묘사
한계 (선택 사항) 페이지별 데이터 결과
페이지 (선택 사항) 현재 페이지 요청
curl --location --request GET 'https://urlkai.com/api/channel/:id?limit=1&page=1' \
--header '권한 부여: 전달자 YOURAPIKEY' \
--헤더 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, 배열(
    CURLOPT_URL => "https://urlkai.com/api/channel/:id?limit=1&page=1",
    CURLOPT_RETURNTRANSFER => 참,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => 참,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "권한 부여: 베어러 YOURAPIKEY",
        "콘텐츠 유형: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
에코 $response; 
var 요청 = require('요청');
var 옵션 = {
    '메서드': 'GET',
    'url': 'https://urlkai.com/api/channel/:id?limit=1&page=1',
    '헤더': {
        'Authorization': '무기명 YOURAPIKEY',
        '콘텐츠 유형': '애플리케이션/json'
    },
    
};
요청(옵션, 함수(오류, 응답) {
    if (error) throw new Error(error);
    console.log(응답.본문);
}); 
가져오기 요청
url = "https://urlkai.com/api/channel/:id?limit=1&page=1"
페이로드 = {}
헤더 = {
    'Authorization': '무기명 YOURAPIKEY',
    '콘텐츠 유형': '애플리케이션/json'
}
응답 = requests.request("GET", url, headers=headers, json=payload)
인쇄(응답.텍스트) 
var 클라이언트 = 새로운 HttpClient ();
var 요청 = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/channel/:id?limit=1&page=1");
요청. Headers.Add("권한 부여", "전달자 YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
요청. 콘텐츠 = 콘텐츠;
var 응답 = await client. SendAsync (요청);
응답. EnsureSuccessStatusCode();
Console.WriteLine(응답을 기다립니다. Content.ReadAsStringAsync()); 
서버 응답
{
    "오류": "0",
    "데이터": {
        "결과": 2,
        "퍼페이지": 2,
        "현재 페이지": 1,
        "다음 페이지": 1,
        "최대 페이지": 1,
        "항목": [
            {
                "type": "링크",
                "아이디": 1,
                "title": "내 샘플 링크",
                "preview": "https:\/\/google.com",
                "link": "https:\/\/urlkai.com\/구글",
                "날짜": "2022-05-12"
            },
            {
                "유형": "바이오",
                "아이디": 1,
                "title": "내 샘플 약력",
                "preview": "https:\/\/urlkai.com\/mybio",
                "link": "https:\/\/urlkai.com\/mybio",
                "날짜": "2022-06-01"
            }
        ]
    }
} 
채널 만들기
POST https://urlkai.com/api/channel/add

이 엔드포인트를 사용하여 채널을 추가할 수 있습니다.

매개 변수 묘사
이름 (필수) 채널 이름
묘사 (선택 사항) 채널 설명
(선택 사항) 채널 배지 색상(HEX)
별표 (선택 사항) 채널에 별표 표시 여부(참 또는 거짓)
curl --location --request POST 'https://urlkai.com/api/channel/add' \
--header '권한 부여: 전달자 YOURAPIKEY' \
--헤더 'Content-Type: application/json' \
--데이터 원시 '{
    "name": "새 채널",
    "description": "내 새 채널",
    "색상": "#000000",
    "별표 표시": 참
}' 
$curl = curl_init();

curl_setopt_array($curl, 배열(
    CURLOPT_URL => "https://urlkai.com/api/channel/add",
    CURLOPT_RETURNTRANSFER => 참,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => 참,
    CURLOPT_CUSTOMREQUEST => "게시",
    CURLOPT_HTTPHEADER => [
        "권한 부여: 베어러 YOURAPIKEY",
        "콘텐츠 유형: application/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "name": "새 채널",
	    "description": "내 새 채널",
	    "색상": "#000000",
	    "별표 표시": 참
	}',
));

$response = curl_exec($curl);

curl_close($curl);
에코 $response; 
var 요청 = require('요청');
var 옵션 = {
    '메서드': '게시',
    'url': 'https://urlkai.com/api/channel/add',
    '헤더': {
        'Authorization': '무기명 YOURAPIKEY',
        '콘텐츠 유형': '애플리케이션/json'
    },
    본문 : JSON.stringify ({
    "name": "새 채널",
    "description": "내 새 채널",
    "색상": "#000000",
    "별표 표시": 참
}),
};
요청(옵션, 함수(오류, 응답) {
    if (error) throw new Error(error);
    console.log(응답.본문);
}); 
가져오기 요청
url = "https://urlkai.com/api/channel/add"
페이로드 = {
    "name": "새 채널",
    "description": "내 새 채널",
    "색상": "#000000",
    "별표 표시": 참
}
헤더 = {
    'Authorization': '무기명 YOURAPIKEY',
    '콘텐츠 유형': '애플리케이션/json'
}
응답 = requests.request("POST", url, headers=headers, json=payload)
인쇄(응답.텍스트) 
var 클라이언트 = 새로운 HttpClient ();
var 요청 = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/channel/add");
요청. Headers.Add("권한 부여", "전달자 YOURAPIKEY");
var 내용 = new StringContent("{
    "name": "새 채널",
    "description": "내 새 채널",
    "색상": "#000000",
    "별표 표시": 참
}", System.Text.Encoding.UTF8, "응용 프로그램/json");
요청. 콘텐츠 = 콘텐츠;
var 응답 = await client. SendAsync (요청);
응답. EnsureSuccessStatusCode();
Console.WriteLine(응답을 기다립니다. Content.ReadAsStringAsync()); 
서버 응답
{
    "오류": 0,
    "아이디": 3,
    "name": "새 채널",
    "description": "내 새 채널",
    "색상": "#000000",
    "별표 표시": 참
} 
채널에 항목 할당하기
POST https://urlkai.com/api/channel/:channelid/assign/:type/:itemid

채널 ID, 항목 유형(링크, 바이오 또는 qr) 및 항목 ID와 함께 요청을 전송하여 모든 채널에 항목을 할당할 수 있습니다.

매개 변수 묘사
:채널ID (필수) 채널 ID
:형 (필수) 링크 또는 약력 또는 QR
:항목 ID (필수) 항목 ID
curl --location --request POST 'https://urlkai.com/api/channel/:channelid/assign/:type/:itemid' \
--header '권한 부여: 전달자 YOURAPIKEY' \
--헤더 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, 배열(
    CURLOPT_URL => "https://urlkai.com/api/channel/:channelid/assign/:type/:itemid",
    CURLOPT_RETURNTRANSFER => 참,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => 참,
    CURLOPT_CUSTOMREQUEST => "게시",
    CURLOPT_HTTPHEADER => [
        "권한 부여: 베어러 YOURAPIKEY",
        "콘텐츠 유형: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
에코 $response; 
var 요청 = require('요청');
var 옵션 = {
    '메서드': '게시',
    'url': 'https://urlkai.com/api/channel/:channelid/assign/:type/:itemid',
    '헤더': {
        'Authorization': '무기명 YOURAPIKEY',
        '콘텐츠 유형': '애플리케이션/json'
    },
    
};
요청(옵션, 함수(오류, 응답) {
    if (error) throw new Error(error);
    console.log(응답.본문);
}); 
가져오기 요청
url = "https://urlkai.com/api/channel/:channelid/assign/:type/:itemid"
페이로드 = {}
헤더 = {
    'Authorization': '무기명 YOURAPIKEY',
    '콘텐츠 유형': '애플리케이션/json'
}
응답 = requests.request("POST", url, headers=headers, json=payload)
인쇄(응답.텍스트) 
var 클라이언트 = 새로운 HttpClient ();
var 요청 = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/channel/:channelid/assign/:type/:itemid");
요청. Headers.Add("권한 부여", "전달자 YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
요청. 콘텐츠 = 콘텐츠;
var 응답 = await client. SendAsync (요청);
응답. EnsureSuccessStatusCode();
Console.WriteLine(응답을 기다립니다. Content.ReadAsStringAsync()); 
서버 응답
{
    "오류": 0,
    "message": "아이템이 채널에 성공적으로 추가되었습니다."
} 
채널 업데이트
PUT https://urlkai.com/api/channel/:id/update

채널을 업데이트하려면 PUT 요청을 통해 JSON으로 유효한 데이터를 보내야 합니다. 데이터는 아래와 같이 요청의 원시 본문으로 전송되어야 합니다. 아래 예제에서는 보낼 수 있는 모든 매개 변수를 보여 주지만 모두 보낼 필요는 없습니다(자세한 내용은 표 참조).

매개 변수 묘사
이름 (선택 사항) 채널 이름
묘사 (선택 사항) 채널 설명
(선택 사항) 채널 배지 색상(HEX)
별표 (선택 사항) 채널에 별표 표시 여부(참 또는 거짓)
curl --location --request PUT 'https://urlkai.com/api/channel/:id/update' \
--header '권한 부여: 전달자 YOURAPIKEY' \
--헤더 'Content-Type: application/json' \
--데이터 원시 '{
    "name": "Acme Corp",
    "description": "Acme Corp의 아이템 채널",
    "색상": "#FFFFFF",
    "별표 표시": 거짓
}' 
$curl = curl_init();

curl_setopt_array($curl, 배열(
    CURLOPT_URL => "https://urlkai.com/api/channel/:id/update",
    CURLOPT_RETURNTRANSFER => 참,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => 참,
    CURLOPT_CUSTOMREQUEST => "놓다",
    CURLOPT_HTTPHEADER => [
        "권한 부여: 베어러 YOURAPIKEY",
        "콘텐츠 유형: application/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "name": "Acme Corp",
	    "description": "Acme Corp의 아이템 채널",
	    "색상": "#FFFFFF",
	    "별표 표시": 거짓
	}',
));

$response = curl_exec($curl);

curl_close($curl);
에코 $response; 
var 요청 = require('요청');
var 옵션 = {
    '메소드': '풋',
    'url': 'https://urlkai.com/api/channel/:id/update',
    '헤더': {
        'Authorization': '무기명 YOURAPIKEY',
        '콘텐츠 유형': '애플리케이션/json'
    },
    본문 : JSON.stringify ({
    "name": "Acme Corp",
    "description": "Acme Corp의 아이템 채널",
    "색상": "#FFFFFF",
    "별표 표시": 거짓
}),
};
요청(옵션, 함수(오류, 응답) {
    if (error) throw new Error(error);
    console.log(응답.본문);
}); 
가져오기 요청
url = "https://urlkai.com/api/channel/:id/update"
페이로드 = {
    "name": "Acme Corp",
    "description": "Acme Corp의 아이템 채널",
    "색상": "#FFFFFF",
    "별표 표시": 거짓
}
헤더 = {
    'Authorization': '무기명 YOURAPIKEY',
    '콘텐츠 유형': '애플리케이션/json'
}
응답 = requests.request("PUT", url, headers=headers, json=payload)
인쇄(응답.텍스트) 
var 클라이언트 = 새로운 HttpClient ();
var 요청 = new HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/channel/:id/update");
요청. Headers.Add("권한 부여", "전달자 YOURAPIKEY");
var 내용 = new StringContent("{
    "name": "Acme Corp",
    "description": "Acme Corp의 아이템 채널",
    "색상": "#FFFFFF",
    "별표 표시": 거짓
}", System.Text.Encoding.UTF8, "응용 프로그램/json");
요청. 콘텐츠 = 콘텐츠;
var 응답 = await client. SendAsync (요청);
응답. EnsureSuccessStatusCode();
Console.WriteLine(응답을 기다립니다. Content.ReadAsStringAsync()); 
서버 응답
{
    "오류": 0,
    "message": "채널이 성공적으로 업데이트되었습니다."
} 
채널 삭제
DELETE https://urlkai.com/api/channel/:id/delete

채널을 삭제하려면 DELETE 요청을 보내야 합니다. 모든 항목도 할당되지 않습니다.

curl --location --request DELETE 'https://urlkai.com/api/channel/:id/delete' \
--header '권한 부여: 전달자 YOURAPIKEY' \
--헤더 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, 배열(
    CURLOPT_URL => "https://urlkai.com/api/channel/:id/delete",
    CURLOPT_RETURNTRANSFER => 참,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => 참,
    CURLOPT_CUSTOMREQUEST => "삭제",
    CURLOPT_HTTPHEADER => [
        "권한 부여: 베어러 YOURAPIKEY",
        "콘텐츠 유형: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
에코 $response; 
var 요청 = require('요청');
var 옵션 = {
    '메소드': '삭제',
    'url': 'https://urlkai.com/api/channel/:id/delete',
    '헤더': {
        'Authorization': '무기명 YOURAPIKEY',
        '콘텐츠 유형': '애플리케이션/json'
    },
    
};
요청(옵션, 함수(오류, 응답) {
    if (error) throw new Error(error);
    console.log(응답.본문);
}); 
가져오기 요청
url = "https://urlkai.com/api/channel/:id/delete"
페이로드 = {}
헤더 = {
    'Authorization': '무기명 YOURAPIKEY',
    '콘텐츠 유형': '애플리케이션/json'
}
응답 = requests.request("삭제", url, headers=headers, json=payload)
인쇄(응답.텍스트) 
var 클라이언트 = 새로운 HttpClient ();
var 요청 = new HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/channel/:id/delete");
요청. Headers.Add("권한 부여", "전달자 YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
요청. 콘텐츠 = 콘텐츠;
var 응답 = await client. SendAsync (요청);
응답. EnsureSuccessStatusCode();
Console.WriteLine(응답을 기다립니다. Content.ReadAsStringAsync()); 
서버 응답
{
    "오류": 0,
    "message": "채널이 성공적으로 삭제되었습니다."
} 

커스텀 스플래쉬

사용자 지정 스플래시 나열
GET https://urlkai.com/api/splash?limit=2&page=1

API를 통해 사용자 지정 시작 페이지를 가져오려면 이 엔드포인트를 사용할 수 있습니다. 데이터를 필터링할 수도 있습니다(자세한 내용은 표 참조).

매개 변수 묘사
한계 (선택 사항) 페이지별 데이터 결과
페이지 (선택 사항) 현재 페이지 요청
컬 --location --request GET 'https://urlkai.com/api/splash?limit=2&page=1' \
--header '권한 부여: 전달자 YOURAPIKEY' \
--헤더 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, 배열(
    CURLOPT_URL => "https://urlkai.com/api/splash?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => 참,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => 참,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "권한 부여: 베어러 YOURAPIKEY",
        "콘텐츠 유형: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
에코 $response; 
var 요청 = require('요청');
var 옵션 = {
    '메서드': 'GET',
    'url': 'https://urlkai.com/api/splash?limit=2&page=1',
    '헤더': {
        'Authorization': '무기명 YOURAPIKEY',
        '콘텐츠 유형': '애플리케이션/json'
    },
    
};
요청(옵션, 함수(오류, 응답) {
    if (error) throw new Error(error);
    console.log(응답.본문);
}); 
가져오기 요청
url = "https://urlkai.com/api/splash?limit=2&page=1"
페이로드 = {}
헤더 = {
    'Authorization': '무기명 YOURAPIKEY',
    '콘텐츠 유형': '애플리케이션/json'
}
응답 = requests.request("GET", url, headers=headers, json=payload)
인쇄(응답.텍스트) 
var 클라이언트 = 새로운 HttpClient ();
var 요청 = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/splash?limit=2&page=1");
요청. Headers.Add("권한 부여", "전달자 YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
요청. 콘텐츠 = 콘텐츠;
var 응답 = await client. SendAsync (요청);
응답. EnsureSuccessStatusCode();
Console.WriteLine(응답을 기다립니다. Content.ReadAsStringAsync()); 
서버 응답
{
    "오류": "0",
    "데이터": {
        "결과": 2,
        "퍼페이지": 2,
        "현재 페이지": 1,
        "다음 페이지": 1,
        "최대 페이지": 1,
        "스플래쉬": [
            {
                "아이디": 1,
                "name": "제품 1 프로모션",
                "date": "2020-11-10 18:00:00"
            },
            {
                "아이디": 2,
                "name": "제품 2 프로모션",
                "날짜": "2020-11-10 18:10:00"
            }
        ]
    }
} 

Files

List Files
GET https://urlkai.com/api/files?limit=2&page=1

Get all of your files. You can also search by name.

매개 변수 묘사
이름 (optional) Search for a file by name
한계 (선택 사항) 페이지별 데이터 결과
페이지 (선택 사항) 현재 페이지 요청
curl --location --request GET 'https://urlkai.com/api/files?limit=2&page=1' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://urlkai.com/api/files?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
var request = require('request');
var options = {
    'method': 'GET',
    'url': 'https://urlkai.com/api/files?limit=2&page=1',
    'headers': {
        'Authorization': 'Bearer YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});
import requests
url = "https://urlkai.com/api/files?limit=2&page=1"
payload = {}
headers = {
    'Authorization': 'Bearer YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=payload)
print(response.text)
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/files?limit=2&page=1");
request.Headers.Add("Authorization", "Bearer YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
서버 응답
{
    "error": 0,
    "result": 3,
    "perpage": 15,
    "currentpage": 1,
    "nextpage": null,
    "maxpage": 1,
    "list": [
        {
            "id": 1,
            "name": "My Photo",
            "downloads": 10,
            "shorturl": "https:\/\/urlkai.com\/iwnRH",
            "date": "2022-08-09 17:00:00"
        },
        {
            "id": 2,
            "name": "My Documents",
            "downloads": 15,
            "shorturl": "https:\/\/urlkai.com\/GGIoI",
            "date": "2022-08-10 17:01:00"
        },
        {
            "id": 3,
            "name": "My Files",
            "downloads": 5,
            "shorturl": "https:\/\/urlkai.com\/nuVmx",
            "date": "2022-08-11 19:01:00"
        }
    ]
}
Upload a file
POST https://urlkai.com/api/files/upload/:filename?name=My+File

Upload a file by sending the binary data as the post body. You need to send the file name including the extension instead of :filename in the url (e.g. brandkit.zip). You can set options by sending the following parameters.

매개 변수 묘사
이름 (optional) File name
관습 (선택 사항) 임의 별칭 대신 사용자 지정 별칭.
도메인 (선택 사항) 사용자 지정 도메인
암호 (선택 사항) 비밀번호 보호
만료 (optional) Expiration for the download example 2021-09-28
maxdownloads (optional) Maximum number of downloads
curl --location --request POST 'https://urlkai.com/api/files/upload/:filename?name=My+File' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '"BINARY DATA"'
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://urlkai.com/api/files/upload/:filename?name=My+File",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS => 
        '"BINARY DATA"',
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
var request = require('request');
var options = {
    'method': 'POST',
    'url': 'https://urlkai.com/api/files/upload/:filename?name=My+File',
    'headers': {
        'Authorization': 'Bearer YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    body: JSON.stringify("BINARY DATA"),
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});
import requests
url = "https://urlkai.com/api/files/upload/:filename?name=My+File"
payload = "BINARY DATA"
headers = {
    'Authorization': 'Bearer YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, json=payload)
print(response.text)
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/files/upload/:filename?name=My+File");
request.Headers.Add("Authorization", "Bearer YOURAPIKEY");
var content = new StringContent(""BINARY DATA"", System.Text.Encoding.UTF8, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
서버 응답
{
    "error": 0,
    "id": 1,
    "shorturl": "https:\/\/urlkai.com\/czeXq"
}

링크


픽셀

목록 픽셀
GET https://urlkai.com/api/pixels?limit=2&page=1

API를 통해 픽셀 코드를 가져오려면 이 엔드포인트를 사용할 수 있습니다. 데이터를 필터링할 수도 있습니다(자세한 내용은 표 참조).

매개 변수 묘사
한계 (선택 사항) 페이지별 데이터 결과
페이지 (선택 사항) 현재 페이지 요청
curl --location --request GET 'https://urlkai.com/api/pixels?limit=2&page=1' \
--header '권한 부여: 전달자 YOURAPIKEY' \
--헤더 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, 배열(
    CURLOPT_URL => "https://urlkai.com/api/pixels?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => 참,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => 참,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "권한 부여: 베어러 YOURAPIKEY",
        "콘텐츠 유형: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
에코 $response; 
var 요청 = require('요청');
var 옵션 = {
    '메서드': 'GET',
    'url': 'https://urlkai.com/api/pixels?limit=2&page=1',
    '헤더': {
        'Authorization': '무기명 YOURAPIKEY',
        '콘텐츠 유형': '애플리케이션/json'
    },
    
};
요청(옵션, 함수(오류, 응답) {
    if (error) throw new Error(error);
    console.log(응답.본문);
}); 
가져오기 요청
url = "https://urlkai.com/api/pixels?limit=2&page=1"
페이로드 = {}
헤더 = {
    'Authorization': '무기명 YOURAPIKEY',
    '콘텐츠 유형': '애플리케이션/json'
}
응답 = requests.request("GET", url, headers=headers, json=payload)
인쇄(응답.텍스트) 
var 클라이언트 = 새로운 HttpClient ();
var 요청 = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/pixels?limit=2&page=1");
요청. Headers.Add("권한 부여", "전달자 YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
요청. 콘텐츠 = 콘텐츠;
var 응답 = await client. SendAsync (요청);
응답. EnsureSuccessStatusCode();
Console.WriteLine(응답을 기다립니다. Content.ReadAsStringAsync()); 
서버 응답
{
    "오류": "0",
    "데이터": {
        "결과": 2,
        "퍼페이지": 2,
        "현재 페이지": 1,
        "다음 페이지": 1,
        "최대 페이지": 1,
        "픽셀": [
            {
                "아이디": 1,
                "유형": "GTMpixel",
                "이름": "GTM 픽셀",
                "태그": "GA-123456789",
                "date": "2020-11-10 18:00:00"
            },
            {
                "아이디": 2,
                "유형": "트위터픽셀",
                "name": "트위터 픽셀",
                "태그": "1234567",
                "날짜": "2020-11-10 18:10:00"
            }
        ]
    }
} 
픽셀 만들기
POST https://urlkai.com/api/pixel/add

이 엔드포인트를 사용하여 픽셀을 만들 수 있습니다. 픽셀 유형과 태그를 보내야 합니다.

매개 변수 묘사
(필수) gtmpixel | 가픽셀 | FBWipixel | 애드워즈픽셀 | 링크드인픽셀 | 트위터픽셀 | 애드롤픽셀 | 쿠오라픽셀 | 핀터레스트 | 빙 | 스냅챗 | 레딧 | 틱톡
이름 (필수) 픽셀의 맞춤 이름
태그 (필수) 픽셀의 태그
curl --location --request POST 'https://urlkai.com/api/pixel/add' \
--header '권한 부여: 전달자 YOURAPIKEY' \
--헤더 'Content-Type: application/json' \
--데이터 원시 '{
    "유형": "GTMpixel",
    "name": "내 GTM",
    "태그": "GTM-ABCDE"
}' 
$curl = curl_init();

curl_setopt_array($curl, 배열(
    CURLOPT_URL => "https://urlkai.com/api/pixel/add",
    CURLOPT_RETURNTRANSFER => 참,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => 참,
    CURLOPT_CUSTOMREQUEST => "게시",
    CURLOPT_HTTPHEADER => [
        "권한 부여: 베어러 YOURAPIKEY",
        "콘텐츠 유형: application/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "유형": "GTMpixel",
	    "name": "내 GTM",
	    "태그": "GTM-ABCDE"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
에코 $response; 
var 요청 = require('요청');
var 옵션 = {
    '메서드': '게시',
    'url': 'https://urlkai.com/api/pixel/add',
    '헤더': {
        'Authorization': '무기명 YOURAPIKEY',
        '콘텐츠 유형': '애플리케이션/json'
    },
    본문 : JSON.stringify ({
    "유형": "GTMpixel",
    "name": "내 GTM",
    "태그": "GTM-ABCDE"
}),
};
요청(옵션, 함수(오류, 응답) {
    if (error) throw new Error(error);
    console.log(응답.본문);
}); 
가져오기 요청
url = "https://urlkai.com/api/pixel/add"
페이로드 = {
    "유형": "GTMpixel",
    "name": "내 GTM",
    "태그": "GTM-ABCDE"
}
헤더 = {
    'Authorization': '무기명 YOURAPIKEY',
    '콘텐츠 유형': '애플리케이션/json'
}
응답 = requests.request("POST", url, headers=headers, json=payload)
인쇄(응답.텍스트) 
var 클라이언트 = 새로운 HttpClient ();
var 요청 = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/pixel/add");
요청. Headers.Add("권한 부여", "전달자 YOURAPIKEY");
var 내용 = new StringContent("{
    "유형": "GTMpixel",
    "name": "내 GTM",
    "태그": "GTM-ABCDE"
}", System.Text.Encoding.UTF8, "응용 프로그램/json");
요청. 콘텐츠 = 콘텐츠;
var 응답 = await client. SendAsync (요청);
응답. EnsureSuccessStatusCode();
Console.WriteLine(응답을 기다립니다. Content.ReadAsStringAsync()); 
서버 응답
{
    "오류": 0,
    "아이디": 1
} 
픽셀 업데이트
PUT https://urlkai.com/api/pixel/:id/update

픽셀을 업데이트하려면 PUT 요청을 통해 JSON으로 유효한 데이터를 보내야 합니다. 데이터는 아래와 같이 요청의 원시 본문으로 전송되어야 합니다. 아래 예제에서는 보낼 수 있는 모든 매개 변수를 보여 주지만 모두 보낼 필요는 없습니다(자세한 내용은 표 참조).

매개 변수 묘사
이름 (선택 사항) 픽셀의 맞춤 이름
태그 (필수) 픽셀의 태그
curl --location --request PUT 'https://urlkai.com/api/pixel/:id/update' \
--header '권한 부여: 전달자 YOURAPIKEY' \
--헤더 'Content-Type: application/json' \
--데이터 원시 '{
    "name": "내 GTM",
    "태그": "GTM-ABCDE"
}' 
$curl = curl_init();

curl_setopt_array($curl, 배열(
    CURLOPT_URL => "https://urlkai.com/api/pixel/:id/update",
    CURLOPT_RETURNTRANSFER => 참,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => 참,
    CURLOPT_CUSTOMREQUEST => "놓다",
    CURLOPT_HTTPHEADER => [
        "권한 부여: 베어러 YOURAPIKEY",
        "콘텐츠 유형: application/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "name": "내 GTM",
	    "태그": "GTM-ABCDE"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
에코 $response; 
var 요청 = require('요청');
var 옵션 = {
    '메소드': '풋',
    'url': 'https://urlkai.com/api/pixel/:id/update',
    '헤더': {
        'Authorization': '무기명 YOURAPIKEY',
        '콘텐츠 유형': '애플리케이션/json'
    },
    본문 : JSON.stringify ({
    "name": "내 GTM",
    "태그": "GTM-ABCDE"
}),
};
요청(옵션, 함수(오류, 응답) {
    if (error) throw new Error(error);
    console.log(응답.본문);
}); 
가져오기 요청
url = "https://urlkai.com/api/pixel/:id/update"
페이로드 = {
    "name": "내 GTM",
    "태그": "GTM-ABCDE"
}
헤더 = {
    'Authorization': '무기명 YOURAPIKEY',
    '콘텐츠 유형': '애플리케이션/json'
}
응답 = requests.request("PUT", url, headers=headers, json=payload)
인쇄(응답.텍스트) 
var 클라이언트 = 새로운 HttpClient ();
var 요청 = new HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/pixel/:id/update");
요청. Headers.Add("권한 부여", "전달자 YOURAPIKEY");
var 내용 = new StringContent("{
    "name": "내 GTM",
    "태그": "GTM-ABCDE"
}", System.Text.Encoding.UTF8, "응용 프로그램/json");
요청. 콘텐츠 = 콘텐츠;
var 응답 = await client. SendAsync (요청);
응답. EnsureSuccessStatusCode();
Console.WriteLine(응답을 기다립니다. Content.ReadAsStringAsync()); 
서버 응답
{
    "오류": 0,
    "message": "픽셀이 성공적으로 업데이트되었습니다."
} 
픽셀 삭제
DELETE https://urlkai.com/api/pixel/:id/delete

픽셀을 삭제하려면 DELETE 요청을 보내야 합니다.

curl --location --request DELETE 'https://urlkai.com/api/pixel/:id/delete' \
--header '권한 부여: 전달자 YOURAPIKEY' \
--헤더 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, 배열(
    CURLOPT_URL => "https://urlkai.com/api/pixel/:id/delete",
    CURLOPT_RETURNTRANSFER => 참,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => 참,
    CURLOPT_CUSTOMREQUEST => "삭제",
    CURLOPT_HTTPHEADER => [
        "권한 부여: 베어러 YOURAPIKEY",
        "콘텐츠 유형: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
에코 $response; 
var 요청 = require('요청');
var 옵션 = {
    '메소드': '삭제',
    'url': 'https://urlkai.com/api/pixel/:id/delete',
    '헤더': {
        'Authorization': '무기명 YOURAPIKEY',
        '콘텐츠 유형': '애플리케이션/json'
    },
    
};
요청(옵션, 함수(오류, 응답) {
    if (error) throw new Error(error);
    console.log(응답.본문);
}); 
가져오기 요청
url = "https://urlkai.com/api/pixel/:id/delete"
페이로드 = {}
헤더 = {
    'Authorization': '무기명 YOURAPIKEY',
    '콘텐츠 유형': '애플리케이션/json'
}
응답 = requests.request("삭제", url, headers=headers, json=payload)
인쇄(응답.텍스트) 
var 클라이언트 = 새로운 HttpClient ();
var 요청 = new HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/pixel/:id/delete");
요청. Headers.Add("권한 부여", "전달자 YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
요청. 콘텐츠 = 콘텐츠;
var 응답 = await client. SendAsync (요청);
응답. EnsureSuccessStatusCode();
Console.WriteLine(응답을 기다립니다. Content.ReadAsStringAsync()); 
서버 응답
{
    "오류": 0,
    "message": "픽셀이 성공적으로 삭제되었습니다."
} 

QR 코드

QR 코드 나열
GET https://urlkai.com/api/qr?limit=2&page=1

API를 통해 QR 코드를 가져오려면 이 엔드포인트를 사용할 수 있습니다. 데이터를 필터링할 수도 있습니다(자세한 내용은 표 참조).

매개 변수 묘사
한계 (선택 사항) 페이지별 데이터 결과
페이지 (선택 사항) 현재 페이지 요청
curl --location --request GET 'https://urlkai.com/api/qr?limit=2&page=1' \
--header '권한 부여: 전달자 YOURAPIKEY' \
--헤더 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, 배열(
    CURLOPT_URL => "https://urlkai.com/api/qr?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => 참,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => 참,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "권한 부여: 베어러 YOURAPIKEY",
        "콘텐츠 유형: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
에코 $response; 
var 요청 = require('요청');
var 옵션 = {
    '메서드': 'GET',
    'url': 'https://urlkai.com/api/qr?limit=2&page=1',
    '헤더': {
        'Authorization': '무기명 YOURAPIKEY',
        '콘텐츠 유형': '애플리케이션/json'
    },
    
};
요청(옵션, 함수(오류, 응답) {
    if (error) throw new Error(error);
    console.log(응답.본문);
}); 
가져오기 요청
url = "https://urlkai.com/api/qr?limit=2&page=1"
페이로드 = {}
헤더 = {
    'Authorization': '무기명 YOURAPIKEY',
    '콘텐츠 유형': '애플리케이션/json'
}
응답 = requests.request("GET", url, headers=headers, json=payload)
인쇄(응답.텍스트) 
var 클라이언트 = 새로운 HttpClient ();
var 요청 = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/qr?limit=2&page=1");
요청. Headers.Add("권한 부여", "전달자 YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
요청. 콘텐츠 = 콘텐츠;
var 응답 = await client. SendAsync (요청);
응답. EnsureSuccessStatusCode();
Console.WriteLine(응답을 기다립니다. Content.ReadAsStringAsync()); 
서버 응답
{
    "오류": "0",
    "데이터": {
        "결과": 2,
        "퍼페이지": 2,
        "현재 페이지": 1,
        "다음 페이지": 1,
        "최대 페이지": 1,
        "qrs": [
            {
                "아이디": 2,
                "link": "https:\/\/urlkai.com\/qr\/a2d5e",
                "스캔": 0,
                "이름": "구글",
                "날짜": "2020-11-10 18:01:43"
            },
            {
                "아이디": 1,
                "link": "https:\/\/urlkai.com\/qr\/b9edfe",
                "스캔": 5,
                "name": "Google 캐나다",
                "date": "2020-11-10 18:00:25"
            }
        ]
    }
} 
단일 QR 코드 받기
GET https://urlkai.com/api/qr/:id

API를 통해 단일 QR 코드에 대한 세부 정보를 얻으려면 이 엔드포인트를 사용할 수 있습니다.

curl --location --request GET 'https://urlkai.com/api/qr/:id' \
--header '권한 부여: 전달자 YOURAPIKEY' \
--헤더 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, 배열(
    CURLOPT_URL => "https://urlkai.com/api/qr/:id",
    CURLOPT_RETURNTRANSFER => 참,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => 참,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "권한 부여: 베어러 YOURAPIKEY",
        "콘텐츠 유형: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
에코 $response; 
var 요청 = require('요청');
var 옵션 = {
    '메서드': 'GET',
    'url': 'https://urlkai.com/api/qr/:id',
    '헤더': {
        'Authorization': '무기명 YOURAPIKEY',
        '콘텐츠 유형': '애플리케이션/json'
    },
    
};
요청(옵션, 함수(오류, 응답) {
    if (error) throw new Error(error);
    console.log(응답.본문);
}); 
가져오기 요청
url = "https://urlkai.com/api/qr/:id"
페이로드 = {}
헤더 = {
    'Authorization': '무기명 YOURAPIKEY',
    '콘텐츠 유형': '애플리케이션/json'
}
응답 = requests.request("GET", url, headers=headers, json=payload)
인쇄(응답.텍스트) 
var 클라이언트 = 새로운 HttpClient ();
var 요청 = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/qr/:id");
요청. Headers.Add("권한 부여", "전달자 YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
요청. 콘텐츠 = 콘텐츠;
var 응답 = await client. SendAsync (요청);
응답. EnsureSuccessStatusCode();
Console.WriteLine(응답을 기다립니다. Content.ReadAsStringAsync()); 
서버 응답
{
    "오류": 0,
    "세부 사항": {
        "아이디": 1,
        "link": "https:\/\/urlkai.com\/qr\/b9edfe",
        "스캔": 5,
        "name": "Google 캐나다",
        "date": "2020-11-10 18:00:25"
    },
    "데이터": {
        "클릭": 1,
        "uniqueClicks": 1,
        "상위 국가": {
            "알 수 없음": "1"
        },
        "상단 리퍼러": {
            "직접, 이메일 및 기타": "1"
        },
        "상단 브라우저": {
            "크롬": "1"
        },
        "탑오스": {
            "윈도우 10": "1"
        },
        "소셜 카운트": {
            "페이스 북": 0,
            "트위터": 0,
            "인스타그램": 0
        }
    }
} 
QR 코드 만들기
POST https://urlkai.com/api/qr/add

QR 코드를 생성하려면 POST 요청을 통해 JSON으로 유효한 데이터를 보내야 합니다. 데이터는 아래와 같이 요청의 원시 본문으로 전송되어야 합니다. 아래 예제에서는 보낼 수 있는 모든 매개 변수를 보여 주지만 모두 보낼 필요는 없습니다(자세한 내용은 표 참조).

매개 변수 묘사
(필수) text | vCard | 링크 | 이메일 | 전화 | 문자 메시지 | 와이파이
데이터 (필수) QR 코드 내부에 삽입될 데이터입니다. 데이터는 유형에 따라 문자열 또는 배열일 수 있습니다
배경 (선택 사항) RGB 색상 예 : rgb (255,255,255)
전경 (선택 사항) RGB 색상 예 : rgb(0,0,0)
로고 (선택 사항) 로고 경로(png 또는 jpg)
이름 (선택 사항) QR 코드 이름
curl --location --POST 'https://urlkai.com/api/qr/add' 요청 \
--header '권한 부여: 전달자 YOURAPIKEY' \
--헤더 'Content-Type: application/json' \
--데이터 원시 '{
    "유형": "링크",
    "data": "https:\/\/google.com",
    "배경": "rgb(255,255,255)",
    "전경": "rgb(0,0,0)",
    "logo": "https:\/\/site.com\/logo.png",
    "이름": "QR 코드 API"
}' 
$curl = curl_init();

curl_setopt_array($curl, 배열(
    CURLOPT_URL => "https://urlkai.com/api/qr/add",
    CURLOPT_RETURNTRANSFER => 참,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => 참,
    CURLOPT_CUSTOMREQUEST => "게시",
    CURLOPT_HTTPHEADER => [
        "권한 부여: 베어러 YOURAPIKEY",
        "콘텐츠 유형: application/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "유형": "링크",
	    "data": "https:\/\/google.com",
	    "배경": "rgb(255,255,255)",
	    "전경": "rgb(0,0,0)",
	    "logo": "https:\/\/site.com\/logo.png",
	    "이름": "QR 코드 API"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
에코 $response; 
var 요청 = require('요청');
var 옵션 = {
    '메서드': '게시',
    'url': 'https://urlkai.com/api/qr/add',
    '헤더': {
        'Authorization': '무기명 YOURAPIKEY',
        '콘텐츠 유형': '애플리케이션/json'
    },
    본문 : JSON.stringify ({
    "유형": "링크",
    "data": "https:\/\/google.com",
    "배경": "rgb(255,255,255)",
    "전경": "rgb(0,0,0)",
    "logo": "https:\/\/site.com\/logo.png",
    "이름": "QR 코드 API"
}),
};
요청(옵션, 함수(오류, 응답) {
    if (error) throw new Error(error);
    console.log(응답.본문);
}); 
가져오기 요청
url = "https://urlkai.com/api/qr/add"
페이로드 = {
    "유형": "링크",
    "데이터": "https://google.com",
    "배경": "rgb(255,255,255)",
    "전경": "rgb(0,0,0)",
    "로고": "https://site.com/logo.png",
    "이름": "QR 코드 API"
}
헤더 = {
    'Authorization': '무기명 YOURAPIKEY',
    '콘텐츠 유형': '애플리케이션/json'
}
응답 = requests.request("POST", url, headers=headers, json=payload)
인쇄(응답.텍스트) 
var 클라이언트 = 새로운 HttpClient ();
var 요청 = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/qr/add");
요청. Headers.Add("권한 부여", "전달자 YOURAPIKEY");
var 내용 = new StringContent("{
    "유형": "링크",
    "data": "https:\/\/google.com",
    "배경": "rgb(255,255,255)",
    "전경": "rgb(0,0,0)",
    "logo": "https:\/\/site.com\/logo.png",
    "이름": "QR 코드 API"
}", System.Text.Encoding.UTF8, "응용 프로그램/json");
요청. 콘텐츠 = 콘텐츠;
var 응답 = await client. SendAsync (요청);
응답. EnsureSuccessStatusCode();
Console.WriteLine(응답을 기다립니다. Content.ReadAsStringAsync()); 
서버 응답
{
    "오류": 0,
    "아이디": 3,
    "link": "https:\/\/urlkai.com\/qr\/a58f79"
} 
QR 코드 업데이트
PUT https://urlkai.com/api/qr/:id/update

QR 코드를 업데이트하려면 PUT 요청을 통해 JSON으로 유효한 데이터를 보내야 합니다. 데이터는 아래와 같이 요청의 원시 본문으로 전송되어야 합니다. 아래 예제에서는 보낼 수 있는 모든 매개 변수를 보여 주지만 모두 보낼 필요는 없습니다(자세한 내용은 표 참조).

매개 변수 묘사
데이터 (필수) QR 코드 내부에 삽입될 데이터입니다. 데이터는 유형에 따라 문자열 또는 배열일 수 있습니다
배경 (선택 사항) RGB 색상 예 : rgb (255,255,255)
전경 (선택 사항) RGB 색상 예 : rgb(0,0,0)
로고 (선택 사항) 로고 경로(png 또는 jpg)
curl --location --request PUT 'https://urlkai.com/api/qr/:id/update' \
--header '권한 부여: 전달자 YOURAPIKEY' \
--헤더 'Content-Type: application/json' \
--데이터 원시 '{
    "유형": "링크",
    "data": "https:\/\/google.com",
    "배경": "rgb(255,255,255)",
    "전경": "rgb(0,0,0)",
    "logo": "https:\/\/site.com\/logo.png"
}' 
$curl = curl_init();

curl_setopt_array($curl, 배열(
    CURLOPT_URL => "https://urlkai.com/api/qr/:id/update",
    CURLOPT_RETURNTRANSFER => 참,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => 참,
    CURLOPT_CUSTOMREQUEST => "놓다",
    CURLOPT_HTTPHEADER => [
        "권한 부여: 베어러 YOURAPIKEY",
        "콘텐츠 유형: application/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "유형": "링크",
	    "data": "https:\/\/google.com",
	    "배경": "rgb(255,255,255)",
	    "전경": "rgb(0,0,0)",
	    "logo": "https:\/\/site.com\/logo.png"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
에코 $response; 
var 요청 = require('요청');
var 옵션 = {
    '메소드': '풋',
    'url': 'https://urlkai.com/api/qr/:id/update',
    '헤더': {
        'Authorization': '무기명 YOURAPIKEY',
        '콘텐츠 유형': '애플리케이션/json'
    },
    본문 : JSON.stringify ({
    "유형": "링크",
    "data": "https:\/\/google.com",
    "배경": "rgb(255,255,255)",
    "전경": "rgb(0,0,0)",
    "logo": "https:\/\/site.com\/logo.png"
}),
};
요청(옵션, 함수(오류, 응답) {
    if (error) throw new Error(error);
    console.log(응답.본문);
}); 
가져오기 요청
url = "https://urlkai.com/api/qr/:id/update"
페이로드 = {
    "유형": "링크",
    "데이터": "https://google.com",
    "배경": "rgb(255,255,255)",
    "전경": "rgb(0,0,0)",
    "로고": "https://site.com/logo.png"
}
헤더 = {
    'Authorization': '무기명 YOURAPIKEY',
    '콘텐츠 유형': '애플리케이션/json'
}
응답 = requests.request("PUT", url, headers=headers, json=payload)
인쇄(응답.텍스트) 
var 클라이언트 = 새로운 HttpClient ();
var 요청 = new HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/qr/:id/update");
요청. Headers.Add("권한 부여", "전달자 YOURAPIKEY");
var 내용 = new StringContent("{
    "유형": "링크",
    "data": "https:\/\/google.com",
    "배경": "rgb(255,255,255)",
    "전경": "rgb(0,0,0)",
    "logo": "https:\/\/site.com\/logo.png"
}", System.Text.Encoding.UTF8, "응용 프로그램/json");
요청. 콘텐츠 = 콘텐츠;
var 응답 = await client. SendAsync (요청);
응답. EnsureSuccessStatusCode();
Console.WriteLine(응답을 기다립니다. Content.ReadAsStringAsync()); 
서버 응답
{
    "오류": 0,
    "message": "QR이 성공적으로 업데이트되었습니다."
} 
QR 코드 삭제
DELETE https://urlkai.com/api/qr/:id/delete

QR 코드를 삭제하려면 DELETE 요청을 보내야 합니다.

curl --location --request DELETE 'https://urlkai.com/api/qr/:id/delete' \
--header '권한 부여: 전달자 YOURAPIKEY' \
--헤더 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, 배열(
    CURLOPT_URL => "https://urlkai.com/api/qr/:id/delete",
    CURLOPT_RETURNTRANSFER => 참,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => 참,
    CURLOPT_CUSTOMREQUEST => "삭제",
    CURLOPT_HTTPHEADER => [
        "권한 부여: 베어러 YOURAPIKEY",
        "콘텐츠 유형: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
에코 $response; 
var 요청 = require('요청');
var 옵션 = {
    '메소드': '삭제',
    'url': 'https://urlkai.com/api/qr/:id/delete',
    '헤더': {
        'Authorization': '무기명 YOURAPIKEY',
        '콘텐츠 유형': '애플리케이션/json'
    },
    
};
요청(옵션, 함수(오류, 응답) {
    if (error) throw new Error(error);
    console.log(응답.본문);
}); 
가져오기 요청
url = "https://urlkai.com/api/qr/:id/delete"
페이로드 = {}
헤더 = {
    'Authorization': '무기명 YOURAPIKEY',
    '콘텐츠 유형': '애플리케이션/json'
}
응답 = requests.request("삭제", url, headers=headers, json=payload)
인쇄(응답.텍스트) 
var 클라이언트 = 새로운 HttpClient ();
var 요청 = new HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/qr/:id/delete");
요청. Headers.Add("권한 부여", "전달자 YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
요청. 콘텐츠 = 콘텐츠;
var 응답 = await client. SendAsync (요청);
응답. EnsureSuccessStatusCode();
Console.WriteLine(응답을 기다립니다. Content.ReadAsStringAsync()); 
서버 응답
{
    "오류": 0,
    "message": "QR 코드가 성공적으로 삭제되었습니다."
}