API 키
웹사이트나 소프트웨어를 Measure Map Online에 연결하는 키를 만들고, 키가 할 수 있는 일을 정하고, 라이브와 테스트 작업을 분리하고, 키를 안전하게 교체하거나 제한하세요.
API 키를 사용하면 직접 운영하는 웹사이트나 소프트웨어가 Measure Map Online 계정과 연동됩니다. 사이트에 프로젝트의 지도를 표시하거나, 방문자를 위해 프로젝트를 시작하거나, REST API로 프로젝트를 읽고 변경할 수 있습니다. 키는 개발자 페이지에서 만들고 관리합니다.
Developer 페이지 열기#
대시보드 메뉴의 고급 아래에서 개발자를 누릅니다. API 키가 먼저 열리며, 나머지 섹션은 그 아래 메뉴에 나열됩니다(휴대폰에서는 페이지 맨 위의 탭).
- 게스트 링크(Open Guest): 웹사이트용 노코드 링크입니다. Open Guest를 참고하세요.
- API 체험, 웹훅, REST API: API 레퍼런스를 참고하세요.
- 지도 임베드(Enterprise): iFrame API를 참고하세요.
- 비공개 프로젝트(Enterprise): 고객의 비공개 프로젝트를 임베드에 표시합니다. 고객의 비공개 프로젝트를 참고하세요.
키 카드 맨 위의 배지는 키의 상태를 알려 줍니다. 활성, 활성화되지 않음(아직 키 없음), 비활성화됨(API 접근이 중지됨: 어떤 키도 작동하지 않고 지원팀이 해제할 때까지 새 키도 만들 수 없음), 만료됨(구독이 활성 상태가 아님) 중 하나입니다.
라이브와 샌드박스#
키 카드 맨 위에서 **라이브**와 **샌드박스**를 전환합니다. 각각 고유한 키가 있으며 페이지에는 선택한 키가 표시됩니다. 이 선택은 API 체험에도 적용되고 섹션 사이를 이동해도 유지됩니다. 지도 임베드와 게스트 링크는 웹사이트 방문자가 라이브 프로젝트만 열 수 있으므로 항상 라이브 키를 사용합니다. 둘 중 하나를 열면 페이지가 **라이브**로 돌아갑니다.
- **라이브**는 실제 계정이며 페이지는 이 환경에서 열립니다. 웹사이트에는 라이브 키를 사용하세요.
- **샌드박스**는 연동을 개발하고 테스트하는 용도입니다. 샌드박스 키로 만든 프로젝트, 폴더, 제품은 실제 항목과 분리되어 보관됩니다. 라이브 키는 이를 볼 수 없고 샌드박스 키는 라이브 항목을 볼 수 없습니다. 샌드박스 키로 보낸 요청은 사용량 수치에 집계되지 않으며, 샌드박스 키로 만든 게스트 프로젝트에는 요금이 청구되지 않습니다.
새 샌드박스 키를 만들어도 라이브 키에는 영향이 없으며, 반대도 마찬가지입니다.
키가 할 수 있는 일 정하기#
키를 만들 때 대화상자에는 새 키의 접근 권한 아래에 API의 각 영역이 나열됩니다. 새 키가 각 영역에 어디까지 접근할 수 있는지 선택하세요.
| 영역 | 선택지 | 허용되는 내용 |
|---|---|---|
| 임베드된 지도(Enterprise) | 접근 불가, 허용됨 | 뷰어를 임베드 지도에 로그인시킵니다. 대부분의 통합에는 이 권한만 있으면 됩니다. |
| 게스트 프로젝트(Open Guest) | 접근 불가, 허용됨 | 서버에서 발급한 토큰으로 방문자를 위한 게스트 프로젝트를 시작합니다. 대부분의 통합에는 이 권한만 있으면 됩니다. |
| 프로젝트 | 접근 불가, 읽기, 읽기 및 변경 | 프로젝트와 폴더, 그리고 측정값, 의견, 내보내기. |
| 사용자(Enterprise) | 접근 불가, 읽기, 읽기 및 변경 | 조직의 사용자와 초대, 좌석, 팀. |
| 조직(Enterprise) | 접근 불가, 읽기, 읽기 및 변경 | 조직의 프로필, 정책, SSO, 활동 기록과 좌석. |
| 제품 | 접근 불가, 읽기, 읽기 및 변경 | 제품 카탈로그와 가격. |
| 게스트(Open Guest) | 접근 불가, 읽기, 읽기 및 변경 | 게스트 링크, 게스트 프로젝트, 견적 요청과 게스트의 연락처, 그리고 예산. |
| 계정 | 접근 불가, 읽기, 읽기 및 변경 | 요금제, 좌석, API 사용량, 프로필과 이메일 설정, 그리고 Open Guest의 경우 지출과 예산. |
| 개발자 | 접근 불가, 읽기, 읽기 및 변경 | API 키와 웹훅. 키는 자신의 권한을 넘어서지 않습니다. |
| 고객(파트너) | 접근 불가, 읽기, 읽기 및 변경 | 고객, 대신 지불하는 요금제, 그들의 초대와 청구서. |
대화상자에는 플랜에 포함된 영역만 표시됩니다. 선택지 위에 포인터를 올리면 정확히 무엇을 허용하는지 볼 수 있습니다. 첫 번째 키는 **임베드된 지도**만 선택된 상태로 시작하며, 임베드 지도에는 이것만 있으면 됩니다. 다른 키를 교체하는 키는 그 키의 접근 권한으로 시작합니다. 최소한 한 영역은 선택해야 합니다.
키가 할 수 있는 일은 만들 때 정해집니다. 키의 접근 권한을 늘리거나 줄이려면 새 키를 만드세요.
키 만들기#
- 키 카드 맨 위에서 라이브 또는 **샌드박스**를 선택합니다.
- 새 키 생성를 누릅니다. 대화상자가 열리며, 제목 옆에 라이브 또는 **샌드박스**가 표시됩니다.
- **새 키의 접근 권한**에서 접근 권한을 설정합니다(위 참고).
- 원하면 키를 구분할 수 있도록 **새 키의 이름(선택 사항)**에 이름을 입력합니다.
- 만들기를 누릅니다.
그러면 대화상자에 새 키가 준비되었습니다. 이 페이지에서 언제든 다시 복사할 수 있습니다.라고 나옵니다. 처음과 끝 문자를 제외하고 가려진 키와 키가 **허용 작업**가 표시됩니다. 를 눌러 키 전체를 표시하거나 를 눌러 키 전체를 복사한 다음 완료을 누르세요. 키 카드의 내 API 키 아래에도 같은 방식으로 표시됩니다. 계정에서 키가 만들어질 때마다 이메일을 받습니다.
접근 설정이 생기기 전에 만든 키#
키에 접근 설정이 생기기 전에 만든 키는 제품 작업을 제외한 모든 것을 할 수 있습니다. 이런 키는 단계적으로 폐지됩니다. 키 카드에 언제 작동이 멈추는지 표시되며 알림도 받습니다. 이때 카드의 주 버튼으로 표시되는 새 키 생성를 누르고, 그 날짜 전에 웹사이트나 서버의 이전 키를 교체하세요. 대화상자는 **임베드된 지도**만 선택된 상태로 시작하므로 서버에 더 필요하다면 더 선택하세요.
키 교체하기#
키가 있을 때 새 키 생성를 다시 누르고 대화상자에서 새 키를 만듭니다. 대화상자에는 현재 키가 어떻게 되는지 나옵니다. 새 키가 생성되며 현재 키는 24시간 동안 계속 작동하므로 키를 사용하는 사이트를 업데이트할 수 있습니다. 완료한 뒤에는 더 일찍 폐기할 수 있습니다. 접근 설정이 생기기 전에 만든 키는 대신 안내받은 날짜까지 계속 작동합니다.
이전 키는 **이전 키**로 이동하며, 남은 시간, 마지막으로 사용된 시점, 할 수 있는 일이 함께 표시됩니다. 새 키를 적용하는 동안에는 계속 허용됩니다. 더 이상 사용하는 곳이 없으면 바로 해지하세요. 즉시 중단하려면 해지를 누르고 확인하세요. 그 키를 계속 쓰던 사이트는 바로 작동을 멈춥니다. 키가 폐기되면 이메일을 받습니다.
웹사이트 제한은 새 키로 복사됩니다. 새 키는 약 1분에 한 번 만들 수 있습니다.
키를 내 웹사이트로 제한하기#
이 목록에 있는 웹사이트만 브라우저에서 내 키를 사용할 수 있습니다. 삽입된 지도와 다른 사이트 페이지의 요청은 거부됩니다. 서버에서의 호출은 영향을 받지 않습니다.
- **웹사이트 제한**에서 **웹사이트 또는 도메인 입력**에
사이트를 입력합니다.
example.com같은 도메인, IP 주소,localhost를 입력할 수 있습니다. 전체 주소를 붙여 넣어도 되며,https://, 경로, 포트를 제외한 사이트 이름만 저장됩니다. - 추가를 누릅니다.
도메인은 하위 도메인도 포함합니다. example.com은 shop.example.com을
허용합니다. 사이트를 삭제하려면 를 누르고 확인하세요.
마지막 사이트까지 삭제하면 키는 어떤 웹사이트에서든 작동합니다. 키에서
웹사이트가 제거될 때마다 이메일을 받습니다.
이 목록은 브라우저에 적용됩니다. 임베드 지도는 목록에 있는 웹사이트의 페이지에서만 열리며, 브라우저가 어떤 페이지인지 알려 주지 않으면 거부됩니다. 웹 페이지에서 보내는 REST API 요청은 목록에 있는 웹사이트에서 와야 합니다. 직접 운영하는 서버에서 보내는 요청에는 웹사이트 이름이 없으므로 확인하지 않습니다. Measure Map Online 자체는 항상 허용되므로 이 페이지의 미리 보기는 계속 작동합니다.
키 사용 현황 보기#
사용량는 모든 라이브 키를 합산하므로 키를 교체해도 수치가 이어집니다. 임베드 지도와 REST API를 합쳐 최근 30일의 요청을 날짜별 막대로 보여 주고, 전체 기간 합계, 마지막 액세스, 현재 키가 만들어진 시점 (키를 만들었습니다), 키를 가장 많이 사용하는 웹사이트인 **상위 도메인**도 보여 줍니다. 여기에 모르는 웹사이트가 있다면 키를 제한하거나 교체해야 한다는 신호입니다.
샌드박스 요청은 집계되지 않으므로 수치는 **라이브**에서만 표시됩니다. API 체험와 미리 보기에서 이 페이지가 직접 보내는 요청도 집계되지 않습니다.
키를 안전하게 보관하기#
- 각 키에는 필요한 접근 권한만 주세요. 웹 페이지에 들어가는 키(예: 임베드 주소)에는 **임베드된 지도**만 있어야 합니다.
- 이 키는 데이터를 변경할 수 있습니다. 웹 페이지나 앱이 아닌 서버에만 보관하세요.
- 웹 페이지에서 사용하는 키는 자신의 웹사이트로 제한하세요.
- 화면을 공유할 때는 키를 페이지에서 가려 두세요. 복사하는 데는 키를 표시할 필요가 없습니다.
- 키가 유출되었을 수 있다면 새 키를 만들고 **이전 키**에서 이전 키를 즉시 폐기하세요.
- 실험한 내용이 실제 프로젝트에 섞이지 않도록 샌드박스 키로 개발과 테스트를 하세요.
도움이 더 필요하신가요?
지원팀에 어떤 작업을 하려고 했는지 알려 주세요. 스크린샷이 있으면 도움이 됩니다.