Managed Runtime API

Managed Runtime API를 사용하여 Commerce Cloud의 Managed Runtime에 배포된 애플리케이션을 제어합니다. Runtime Admin 웹 애플리케이션과 동일한 기능은 물론, 더 많은 관리 기능과 구성 옵션까지 제공하는 맞춤형 도구를 만들 수 있습니다.

Managed Runtime API는 관리 목적으로만 사용됩니다. 스토어프런트 코드에 있는 API에 대한 요청을 하지 마십시오.

이 가이드에서는 사용자가 이미 Managed Runtime과 프로젝트, 환경, 번들 및 배포와 같은 관련 개념을 잘 알고 있다고 가정합니다. 자세한 내용은 Managed Runtime 개요를 참조하십시오.

Mobify 브랜드 이름은 Managed Runtime API의 기본 URL에 있는 mobify.com 도메인에 나타납니다. 새로운 Salesforce 도메인이 Mobify 도메인을 대신하게 되지만 Mobify 도메인도 계속 지원합니다.

API 요청을 하려면 HTTP 요청 Authorization 헤더에 값이 Bearer {{api_key}}인 API 키를 포함해야 합니다.

API 키를 찾으려면 Runtime Admin 도구에 로그인하여 Account Settings(계정 설정) 페이지로 이동하십시오.

스크립트가 사용자 대신 작업을 수행할 수 있도록 하므로 API 키를 암호처럼 취급하십시오.

curl 명령으로 포맷된 몇 가지 샘플 요청을 기반으로 한, 간단한 튜토리얼을 통해 API 사용 방법을 알려드리겠습니다.

명령을 실행하기 전에 자리 표시자를 실제 값으로 바꿉니다. 자리 표시자는 {{placeholder}}와 같은 형식입니다.

대부분의 요청에서는 {{project_id}}를 실제 프로젝트 ID로 대체해야 합니다. 프로젝트 ID를 찾으려면 Runtime Admin 도구에 로그인하여 프로젝트의 설정 페이지로 이동하십시오.

프로젝트 ID는 최대 20자로 지정할 수 있으며 조직에서 고유해야 합니다.

Managed Runtime API에 대한 첫 번째 요청은 프로젝트에 속한 모든 환경(또는 API에서 "대상"이라고 함)을 나열합니다.

이제 production에 배포하기 전에 변경 사항을 검증하는 데 사용할 수 있는 staging이라는 환경을 만들어 보겠습니다.

새 환경을 사용하려면 환경에 번들을 배포해야 합니다.

새로 만든 staging 환경의 세부 사항을 검토해보겠습니다.

마지막으로 staging의 프록시 구성을 수정해보겠습니다.

구성을 변경하면 변경 내용이 적용되도록 현재 번들이 자동으로 다시 배포됩니다.

API를 사용하는 데 문제가 있는 경우 다음 문제 해결 단계를 시도해보십시오.

  • curl 명령에 --fail 인수를 추가합니다.
  • API 키를 확인합니다.
  • 프로젝트 ID를 확인합니다.

API 엔드포인트는 브라우저에서도 작동합니다. Runtime Admin 도구에 로그인한 다음 브라우저에서 직접 사용 중인 엔드포인트를 엽니다.

API의 기능을 알아보고 샘플 요청도 몇 가지 실행해보았습니다. API에 대해 자세히 알아보려면 API 사양을 참조하십시오.