본문으로 이동
Rankupedia
Rankupedia회원가입

개요: API

DR 체커 도구 API: 모든 파라미터와 필드 설명

요청 형식과 인증된 응답이 항상 포함하는 두 필드에 대한 참조입니다. 액션별 행은 다르므로 구문 분석 전에 한 번 호출해 보세요.

API 기본 URL을 나타내는 돌다리와 인증을 위한 철 ключ을 든 작업자

이 서비스는 JSON을 반환하는 REST API입니다. CORS가 개방되어 있어 브라우저 페이지에서 직접 호출할 수 있습니다. 키는 sk_로 시작하며, Google 로그인 후 계정 페이지에서 발급됩니다.

베이스 URL은 https://rankupedia.com/api.php입니다. 쿼리 문자열에 key=sk_...를 사용하거나 Authorization: Bearer sk_... 헤더를 통해 인증합니다. 클라이언트에 따라 선호하는 방식을 선택하세요. 네 가지 액션(domain, overview, stats, suggest)은 인증이 필요하지 않습니다.

출력을 파싱할 수 있어야만 DR 체커 도구가 유용합니다. 아래 샘플은 가장 작은 유효한 사례이며, 그 이후의 섹션에서는 사람들이 흔히 실수하는 부분을 다룹니다.

한 번의 호출, 주석 포함

무료 overview 액션. 도메인을 자신의 도메인으로 교체하세요.

bash
curl "https://rankupedia.com/api.php?action=overview&q=nytimes.com"

# authenticated listing, 100 rows per page:
curl -H "Authorization: Bearer sk_live_..." \
  "https://rankupedia.com/api.php?action=refdomains&q=nytimes.com&per=100&page=1&order=desc"

요청의 구조

01

액션 선택

action 값은 실행할 작업과 비용을 결정합니다. 무료 액션은 비용 표에 나열되어 있습니다.

02

대상 지정

q 값은 nytimes.com과 같은 순수 도메인이어야 하며, 스키마나 경로는 포함하지 않습니다.

03

유료 액션의 경우 자격 증명을 추가하세요

쿼리 문자열의 key 또는 Bearer 헤더를 사용하세요. 헤더를 사용하면 키가 서버 로그와 브라우저 기록에 남지 않습니다.

04

페이지 및 정렬

page와 per는 결과를 분할하고 sort와 order는 결과를 정렬합니다. 페이지네이션은 50,000행에서 중단됩니다.

첫 번째 호출 전 도메인 목록 준비

이상한 결과의 많은 부분이 서버가 아닌 입력에서 시작합니다. 목록을 한 번 정리한 후 전송하세요.

순수 도메인이 아닌 모든 내용을 제거하세요. 경로가 포함된 주소는 q 값이 예상하지 못한 문자를 추가하므로 스키마, 경로 및 후행 슬래시를 제거해야 합니다.

스키마와 경로 제거

호출 전 https://shop.example.org/blog/를 shop.example.org로 변환하세요. q 값은 순수 도메인을 받으므로 경로는 전송되지 않고 생략됩니다.

스프레드시트는 이러한 세부 정보를 셀 내부에 숨깁니다. 슬래시와 콜론에 대한 빠른 필터링으로 대부분을 잡을 수 있습니다.

이름을 소문자로 변환하고 중복 제거

도메인 이름은 대소문자를 구분하지 않으므로 Example.COM과 example.com은 하나의 대상을 가리킵니다. 둘 다 전송하면 하나의 답변에 대해 크레딧이 두 번 소모됩니다.

호출 횟수를 세기 전에 중복을 제거하세요. 300개의 중복이 있는 2,100개의 이름 목록은 raw 상태에서는 bulk_dr 호출을 두 번 필요로 하지만, 중복 제거 후 1,800개의 고유 이름은 한 번의 호출로 처리할 수 있습니다.

루트 도메인과 서브도메인 중 선택

blog.example.org와 같은 서브도메인은 목록에서 자체 이름으로 간주됩니다. 무언가를 전송하기 전에 질문의 대상이 무엇인지 결정하세요.

질문이 전체 사이트를 아우르는 경우 루트 이름을 전송하세요. 하나의 서브도메인만 다루는 경우 해당 정확한 이름을 테스트하고 답변을 해당 서브도메인만의 것으로 해석하세요.

결정을 작업 메모에 기록하세요. 그러면 다음 실행(아마도 다른 사람이 수행) 시 동일한 규칙이 적용됩니다.

쿼리 파라미터

파라미터의미참고 사항
action실행할 작업필수; 비용 표 참조
q대상 도메인예: nytimes.com
keyAPI 키또는 Bearer 헤더 사용
page결과 페이지 번호심층 페이지네이션은 50,000으로 제한됩니다
per페이지당 행 수10부터 5000까지 허용; 한 번의 호출은 행 수에 관계없이 한 번의 청구로 처리됩니다
sort정렬할 열사용 가능한 열은 액션에 따라 다릅니다
orderasc 또는 descsort와 함께 사용
domainsbulk_dr용 목록각각 최대 2,000개의 도메인, GET 또는 POST 본문으로 전송
컨베이어 벨트 위의 나무 상자 행을 측정하기 위해 큰 자를 사용하는 작업자

긴 목록의 페이지네이션

목록 액션은 페이지 단위로 행을 반환합니다. 두 파라미터가 슬라이스를 제어합니다: page는 어떤 슬라이스를 선택할지, per는 그 슬라이스가 얼마나 많은 행을 포함할지 결정합니다. per는 10부터 5000까지의 값을 허용합니다.

먼저 페이지 크기를 선택하세요. 더 큰 per 값은 호출 횟수를 줄여주며, 과금은 행이 아닌 호출 횟수를 기준으로 합니다.

페이지네이션 전 정렬

sort와 order는 첫 번째 페이지에 어떤 행이 나타날지 결정합니다. 시리즈의 모든 호출에서 둘 다 설정하여 각 페이지가 동일한 순서에서 나오도록 하세요.

가장 강력한 행을 먼저 보고 싶다면 메트릭 열에 desc를 사용하고, 가장 약한 행을 찾고 있다면 asc를 사용하세요. 사용 가능한 열 이름은 액션에 따라 다릅니다.

긴 실행을 신뢰하기 전에 두 페이지의 작은 테스트로 순서를 확인하세요.

50,000행 제한에서 중단

심층 페이지네이션은 50,000행에서 중단됩니다. 그 이후로는 호출이 새로운 정보를 반환하지 않으므로 계속 페이지네이션하는 루프는 크레딧을 낭비합니다.

질문을 좁히거나 작업을 더 작은 단위로 나누어 실행하세요. 다른 대상을 대상으로 한 두 번째 쿼리가 일반적으로 더 깔끔한 결과를 제공합니다.

깊이(depth) 제한은 목록의 속성이므로 이를 호출하는 모든 클라이언트에 적용됩니다.

짧은 페이지에서 루프를 종료합니다.

페이지가 반환하는 행(row) 수가 per 값보다 적을 때 중단합니다. 이는 목록이 모두 소진되었음을 나타내는 일반적인 신호입니다.

이 테스트를 문제 해결 항목의 잔액 확인과 함께 사용하여, 마지막 페이지에 도달하거나 잔액이 부족할 때 루프가 종료되도록 합니다.

모든 응답에 포함되는 필드

ok

부울(Boolean) 값입니다. True는 호출이 완료되었음을, False는 호출이 실패했음을 의미하며, HTTP 상태 코드가 실패 원인을 알려줍니다.

_credits

인증된 호출에서 표시됩니다. 이 호출의 비용과 남은 크레딧 잔액을 보고하여, 잔액이 고갈되기 전에 루프를 종료할 수 있게 합니다.

여기서 문서화하지 않는 사항

각 액션의 행 레벨 필드 이름은 실제 응답에서 확인할 수 있습니다. 서비스와의 불일치를 방지하기 위해 이 항목에서는 이를 재현하지 않습니다.

루프 작성 전 호출 테스트하기

01

알고 있는 도메인을 선택하세요

자체 페이지를 통해 프로필을 판단할 수 있는 사이트를 선택하세요. 잘 알려진 도메인은 이상한 수치를 쉽게 식별하는 데 도움이 됩니다.

02

무료 호출을 하나 보내세요

키 없이 overview 또는 domain을 실행하세요. 응답은 JSON의 실제 구조를 보여주며, 이는 이 항목을 포함한 어떤 설명보다 신뢰할 수 있습니다.

03

가장 작은 페이지 크기로 유료 호출을 하나 보내세요

목록 액션에서 per=10을 사용하세요. 확장하기 전에 행 필드와 _credits 값을 확인할 수 있습니다.

04

_credits를 읽은 후 확장하세요

하나의 호출 비용을 계획 내 호출 횟수로 곱하세요. 총 비용이 잔액보다 크면 루프 시작 전에 계획을 축소하세요.

클라이언트 배포 전

  • 다른 필드를 읽기 전에 ok를 확인하세요
  • 모든 호출에서 _credits를 로깅하세요
  • 데이터를 월별 스냅샷으로 취급하세요
  • 401 및 402 오류를 별도로 처리하세요. 문제 해결 항목 참조
  • API 키를 프론트엔드 코드에서 분리하세요
돌 더미에서 흔한 자갈을 걸러내기 위해 체를 흔드는 정원사

배치 처리 관련 참고사항

bulk_dr 액션은 호출당 최대 2,000개의 도메인을 허용합니다. domains 쿼리 값으로 전달하거나, URL에 적합하지 않을 정도로 목록이 길 경우 POST 본문(body)으로 전달하세요.

compare는 최대 20개의 도메인을, intersect는 2~10개의 도메인을 처리합니다. Intersect은 하나의 질문에 답합니다: 명명된 모든 도메인에 링크하는 사이트는 어디인가?

청구가 호출 단위로 이루어지므로, 더 큰 배치당 행 단위 비용이 항상 저렴합니다. 또한 배치는 단일 단위로 실패합니다. 재시도할 수 있는 크기로 청크(chunk)를 나누세요.

긴 목록은 POST 본문에 포함할 수 있습니다. 거부된 배치에는 사용할 수 있는 행이 없으므로, 응답의 다른 내용보다 먼저 ok를 읽으세요.

가정 없이 JSON 읽기

파서는 응답에서 누락된 필드에서 오류가 발생합니다. 모든 행에 모든 키가 있다고 가정하는 코드는 취약하며, 짧은 행 하나만으로도 전체 작업이 중단될 수 있습니다.

누락된 필드를 정상적인 상황으로 취급하세요

행 필드는 액션에 따라 다르므로, 한 목록에 있는 필드가 다른 목록에는 없을 수 있습니다. 각 필드에 기본값을 설정하고 계속 진행하세요.

무엇이 실패했는지뿐만 아니라 어떤 필드가 누락되었는지 로깅하세요. 해당 로그는 스키마가 변경되었는지 아니면 자체 코드가 변경되었는지를 보여줍니다.

샘플에 대한 원본 응답 보관

새로운 작업의 첫 몇 호출에 대한 원본 JSON을 저장하세요. 나중에 숫자가 잘못 보일 때, 저장된 텍스트는 기억보다 빠르게 문제를 해결해 줍니다.

샘플을 날짜 및 액션 이름과 함께 저장하세요. 월별 업데이트로 인해 같은 호출이 다음 달에는 다른 행을 반환할 수 있습니다.

가족별 액션

가족액션일반적인 용도
무료domain, overview, stats, suggest빠른 조회 및 자동 완성
스코어링bulk_dr, compare, dr_distribution목록 스크리닝 및 피어 세트 구성
목록refdomains, backlinks, anchors, toppages, anchor_cloud단일 사이트 감사
검색search, keyword, intersect특정 anchor text로 링크하거나 여러 경쟁 사이트에 링크하는 사이트 찾기
이 항목의 한계

행 레벨 필드 이름은 액션에 따라 다르며 여기에 나열되지 않았습니다. 잘 알려진 도메인에서 무료 액션으로 엔드포인트를 호출하고 JSON을 읽어보세요. 이것이 유일한 권위 있는 출처입니다.

개발자가 묻는 파라미터 질문

네 가지 파라미터 질문은 API 사용 첫 주 대부분을 커버합니다.

모든 호출에 키가 필요한가요?

아니요. domain, overview, stats, suggest 액션은 키가 필요하지 않습니다. 유료 액션은 키 파라미터 또는 Bearer 헤더로 전송된 키가 필요합니다.

URL에 키를 보낼 수 있나요?

네, key 파라미터는 쿼리 문자열에서 작동합니다. 헤더를 사용하면 키가 주소 자체에 포함되지 않아 로그 및 공유 링크에 더 선호됩니다.

per 값을 5000 이상으로 설정하고 싶다면?

문서화된 범위는 10에서 5000입니다. 이 범위를 벗어난 값은 이 항목에서 설명하는 범위를 벗어나므로, 값을 범위 내에 유지하고 페이지네이션을 사용하세요.

q 파라미터에서 대소문자가 중요한가요?

도메인 이름은 대소문자를 구분하지 않으므로, 전송 전에 값을 소문자로 변환하세요. 하나의 철자만 사용하면 실행 간 결과 비교가 더 쉬워집니다.