이 문서에서는 Roads API 사용을 시작하는 데 필요한 단계를 설명합니다.
기본 요건
이 절차에서는 결제가 사용 설정된 Google Cloud 계정 및 Google Cloud 프로젝트를 설정하는 방법을 안내합니다. Roads API 사용에 대한 요금 청구 방식도 숙지해야 합니다.
- Roads API 사용량 및 청구에서 사용량에 대한 청구 및 비용을 검토합니다.
Google Cloud 계정이 있는지 확인합니다.
Google Cloud 콘솔에 로그인결제가 사용 설정된 Google Cloud 프로젝트가 있는지 확인합니다.
결제 페이지로 이동- 프로젝트를 선택하여 결제 페이지를 엽니다.
결제 페이지에서 다음을 수행합니다.
- 선택한 프로젝트에 결제가 이미 사용 설정되어 있고 결제 계정이 하나만 있는 경우 결제 페이지가 열립니다.
- 결제 계정이 여러 개인 경우 연결된 결제 계정으로 이동을 선택하여 프로젝트와 연결된 결제 계정에 대한 세부정보를 확인합니다.
- 결제 계정이 있지만 프로젝트와 연결되어 있지 않으면 결제 계정을 프로젝트에 연결하라는 메시지가 표시됩니다.
- 결제 계정이 없거나 새 결제 계정을 만들려면 결제 계정 관리를 선택하여 새 결제 계정을 만듭니다. 자세한 내용은 새 셀프 서비스 Cloud Billing 계정 만들기를 참조하세요.
API 사용 설정
Roads API를 사용하려면 먼저 Google Cloud 콘솔 또는 gcloud 명령어를 사용하여 Google Cloud 프로젝트에서 사용 설정해야 합니다.
API를 사용 설정하려면 다음 안내를 따르세요.
콘솔
Google Cloud 콘솔에서 제품 페이지를 엽니다.
Roads API 사용 설정사용 설정 버튼을 클릭합니다.
gcloud
gcloud services enable \ --project "PROJECT" \ "roads.googleapis.com"
Google Cloud SDK, Cloud SDK 설치 및 다음 명령어에 대해 자세히 알아보세요.
Roads API에서 사용할 API 키 가져오기
Google Maps Platform 제품은 API 호출에 API 키를 포함하도록 요구하여 무단 사용으로부터 보호합니다.
API 키는 Cloud Billing 계정 및 Google Cloud 프로젝트를 애플리케이션에서 Google Maps Platform API 또는 SDK에 보내는 요청과 연결하는 고유한 영숫자 문자열입니다. 새 키를 만들거나 기존 키에 API 또는 SDK를 추가하려면 다음 안내를 따르세요.
콘솔
-
Google Maps Platform > 키 및 사용자 인증 정보 페이지로 이동합니다.
- 메시지가 나타나면 프로젝트를 선택합니다.
-
다음 중 하나를 수행합니다.
-
새 키 만들기:
- 사용자 인증 정보 만들기 > API 키를 클릭합니다.
- API 키 만들기 패널에서 API 제한사항 선택 목록을 엽니다.
- 이 키에 필요하지 않은 API를 모두 지우고 Roads API가 선택된 상태로 유지되는지 확인합니다.
- 만들기를 클릭합니다. 패널에 새 API 키가 표시됩니다.
-
기존 키 사용:
- 키 이름을 클릭합니다.
- API 제한사항 선택 목록에서 Roads API을 선택합니다.
- 저장을 클릭합니다.
여기에서 API를 선택해도 사용 설정되지 않습니다. Roads API가 API 라이브러리 페이지에서 사용 설정되어 있는지 확인합니다.
-
- 나중에 키 문자열을 보려면 키 및 사용자 인증 정보 페이지로 이동하여 키의 키 표시를 클릭합니다.
콘솔이 이 단계와 다르게 표시되면 Google Cloud 문서의 API 키 만들기 및 API 제한사항 추가를 참고하세요.
gcloud
다음 명령어에서 PROJECT_ID를 프로젝트 ID로 바꿉니다.
-
새 키 만들기: 다음 명령어를 실행하고 DISPLAY_NAME를 키 이름으로 바꿉니다.
gcloud services api-keys create \ --project="PROJECT_ID" \ --display-name="DISPLAY_NAME" \ --api-target=service=roads.googleapis.com
Google Cloud SDK, Cloud SDK 설치 및 다음 명령어에 대해 자세히 알아보세요.
-
기존 키 사용: 다음 명령어를 실행하고 KEY_ID를 키 ID로 바꿉니다.
--append플래그는 키가 이미 허용하는 API를 유지합니다. 이 플래그가 없으면 명령어가 이를 대체합니다.gcloud services api-keys update KEY_ID \ --project="PROJECT_ID" \ --append \ --api-target=service=roads.googleapis.com
Google Cloud SDK, Cloud SDK 설치 및 다음 명령어에 대해 자세히 알아보세요.
키 ID는 키 문자열 또는 표시 이름이 아닙니다. 이를 찾으려면
gcloud services api-keys list --project="PROJECT_ID"를 실행합니다. ID는name필드의 마지막 부분입니다.projects/PROJECT_NUMBER/locations/global/keys/KEY_ID
키 문자열을 보려면 gcloud services api-keys get-key-string KEY_ID
--project="PROJECT_ID"를 실행합니다.
API 요청하기
Roads API 요청을 실행하여 지정된 포인트를 도로 도형에 맞추는 JSON 응답을 반환합니다. 모든 요청에 API 키의 영숫자 문자열을 포함해야 하며 API 키가 포함된 요청에는 HTTPS를 사용해야 합니다.
아래 코드에서 API_KEY를 클릭하여 키의 영숫자 문자열을 삽입합니다.
curl -L -X GET 'https://roads.googleapis.com/v1/snapToRoads
?path=-35.27801%2C149.12958%7C-35.28032%2C149.12907%7C-35.28099%2C149.12929%7C-35.28144%2C149.12984%7C-35.28194%2C149.13003%7C-35.28282%2C149.12956%7C-35.28302%2C149.12881%7C-35.28473%2C149.12836 &interpolate=true &key=YOUR_API_KEY' - 코드 샘플
에서 복사 아이콘을 클릭하여 curl명령어를 복사합니다. - 터미널 창에 명령어를 붙여넣고 명령어를 실행합니다.
응답은 다음과 같은 형식의 JSON 객체입니다.
{ "snappedPoints": [ { "location": { "latitude": -35.278004899930188, "longitude": 149.129531998742 }, "originalIndex": 0, "placeId": "ChIJr_xl0GdNFmsRsUtUbW7qABM" }, { "location": { "latitude": -35.2784195, "longitude": 149.12946589999999 }, "placeId": "ChIJr_xl0GdNFmsRsUtUbW7qABM" }, ... { "location": { "latitude": -35.284727644851415, "longitude": 149.12833853807396 }, "originalIndex": 7, "placeId": "ChIJtWxAZmpNFmsRlbUCkc6VtnA" } ] }
API 키 제한사항 적용
API 키를 필요한 API 및 앱에서만 사용하도록 제한하는 것이 좋습니다. API 키를 제한하면 불필요한 요청으로부터 애플리케이션이 보호되어 애플리케이션의 보안이 강화됩니다. API 키는 두 가지 유형의 제한사항을 지원합니다.
- API 제한사항은 API 키를 사용해서 호출할 수 있는 SDK 및 API를 지정합니다. 키를 만들 때 콘솔과 gcloud CLI에는 하나 이상의 API 제한이 필요합니다.
- 애플리케이션 제한사항은 API 키를 사용할 수 있는 웹사이트, IP 주소 또는 앱을 지정합니다.
제한사항 적용에 대한 자세한 내용은 API 키 제한을 참고하세요.
다음 단계
이제 Roads API를 사용 설정하고 요청을 성공적으로 수행했으므로 Snap to Roads를 참고하여 API 사용에 대해 자세히 알아보세요.