하는 일
“연동” 메뉴의 “API 키” 탭입니다. “API 키” 표에는 “이름”, 키의 앞부분(“키”), 읽기 “범위”, “사이트”, “상태”(“활성”·“폐기됨”·“만료됨”), “마지막 사용”, “만료”가 나옵니다. 키 전체는 만들 때 한 번만 보이고, 목록에는 앞부분만 남습니다.
“공개 읽기 API” 영역은 키로 부르는 방법을 알려 줍니다. 요청 헤더에 Authorization: Bearer <키> 를 넣어 GET /v1/leads 와 GET /v1/stats 를 부르며, 키마다 분당 60회까지입니다. 리드는 GET /v1/leads 로, 통계는 GET /v1/stats 로 읽습니다. 통계의 from·to 는 사이트 시간대의 날짜(YYYY-MM-DD)이고 양끝을 포함해 최대 365일이며, 콘솔 통계와 같은 숫자를 돌려줍니다.
API 키는 요금제에 따라 쓸 수 있습니다. 조직의 요금제에 웹훅·API 기능이 없으면 “웹훅·API 는 Growth 요금제부터 쓸 수 있습니다” 안내와 “요금제 보기”가 나오고 새 키를 만들 수 없습니다. 이미 만든 키는 볼 수 있고 폐기할 수 있습니다.
단계
1단계 · 새 키 만들기
“새 API 키”를 누르고 어디에 쓰는 키인지 알아볼 “이름”을 넣습니다.
2단계 · 범위와 만료 고르기
“읽기 범위”에서 “리드 읽기 (leads:read)”와 “통계 읽기 (stats:read)” 중 하나 이상을 고릅니다. “사이트 범위”는 “모든 사이트 (나중에 만들 사이트 포함)” 또는 “고른 사이트만”입니다. “만료”는 “만료 없음”, “30일 뒤”, “90일 뒤”, “365일 뒤” 중에서 고르며 처음에는 “90일 뒤”입니다.
3단계 · 비밀번호 확인하기
“API 키 만들기”를 누르면 “현재 비밀번호”를 묻는 창이 뜹니다. 입력하고 “확인하고 저장”을 누릅니다.
4단계 · 키 저장하기
“API 키를 만들었습니다” 창에 키가 한 번만 보입니다. “API 키 복사”로 복사해 안전한 곳에 저장하고 “저장했습니다”를 누릅니다. 다른 방법으로 닫으려 하면 “저장하지 않고 닫을까요?”를 묻습니다.
5단계 · 필요 없는 키 폐기하기
표의 “폐기”를 누르고 확인합니다. 그 키로 오는 요청은 바로 거부되며 되돌릴 수 없습니다.
권한
“연동” 메뉴는 Owner·Admin 만 열 수 있고, 키를 만들고 폐기하는 것도 Owner·Admin 만 할 수 있습니다. Editor·Analyst 에게는 메뉴가 보이지 않으며, 주소를 직접 열면 “이 작업을 할 권한이 없습니다.”가 나옵니다.
요금제에 웹훅·API 기능이 없으면 “새 API 키”가 보이지 않습니다. 조직이 읽기 전용이면 “새 API 키”가 꺼지고 “조직이 읽기 전용이라 바꿀 수 없습니다.”가 보입니다.
자주 묻는 질문
- 만든 키를 다시 볼 수 있나요?
- 볼 수 없습니다. 키는 만들 때 한 번만 보이고 목록에는 앞부분만 남습니다. 잃어버렸으면 새 키를 만들고 옛 키를 폐기하세요.
- 키를 더 만들 수 없다고 나옵니다.
- 활성 API 키는 조직당 25개까지입니다. “활성 API 키는 조직당 25개까지입니다. 쓰지 않는 키를 폐기하세요.”가 나오면 쓰지 않는 키를 폐기한 뒤 다시 만드세요.
- 만들 때 칸 밑에 오류가 나옵니다.
- 이름은 1~80자여야 하고, 범위는 하나 이상 골라야 합니다. “고른 사이트만”을 골랐다면 이 조직의 사이트를 하나 이상 골라야 합니다. 만료는 오늘 뒤 365일 안이어야 합니다.
- 내가 폐기하지 않은 키가 “폐기됨”입니다.
- 키를 만든 사람이 조직에서 빠지거나 그 사람의 역할이 Editor·Analyst 로 바뀌면 그 사람이 만든 키가 폐기됩니다. 표의 이름 밑에 “만든 사람이 조직에서 빠짐” 또는 “만든 사람의 역할이 바뀜”으로 이유가 보입니다. 만료일이 지난 키는 “만료됨”이 됩니다.