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에서 "대상"이라고 함)을 나열합니다.

projects_target_list API 엔드포인트를 호출하여 환경을 나열합니다.

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

먼저 projects_target_create API 엔드포인트를 호출합니다. 프로젝트를 생성하는 경우 projects_create API 엔드포인트를 호출하여 환경을 생성할 수도 있습니다.

그런 다음 cc_b2c_target_info_update API 엔드포인트를 호출하여 Commerce Cloud 인스턴스와 하나 이상의 사이트를 환경에 연결합니다.

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

projects_target_retrieve API 엔드포인트를 호출하여 만든 staging 환경의 세부 정보를 검토해 보겠습니다.

마지막으로 projects_target_partial_update API 엔드포인트를 호출하여 staging의 프록시 구성을 수정해 보겠습니다.

구성을 변경하면 구성 업데이트를 적용하기 위해 배포된 번들이 다시 배포됩니다.

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

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

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

Managed Runtime API를 사용하여 지속적인 통합 및 배포를 지원하려면 자동화를 위한 Account Manager 사용자를 생성합니다.

  • Google 그룹과 같은 공유 이메일 주소를 사용하여 Account Manager에서 사용자 계정을 만듭니다. 연결된 자격 증명 및 MFA 코드를 LastPass와 같은 암호 관리자에 저장합니다.
  • 사용자에게 Managed Runtime User 역할을 부여합니다.
  • Runtime Admin에서 사용자에게 필요한 권한을 할당합니다. 사용자의 Managed Runtime API 키는 사용자의 권한에 따라 허용되는 대상에만 액세스할 수 있습니다. CI/CD가 상호 작용해야 하는 프로젝트에 맞게 유지하십시오.
  • 사용자를 위한 API 키를 생성하여 지속적 통합 시스템에 저장합니다.

Managed Runtime API 키를 활성 상태로 유지하려면 조직의 Account Manager 구성에서 요구되는 대로 암호를 업데이트하여 관련 Account Manager 계정을 활성 상태로 유지해야 합니다. 사용자가 비활성화되어 있는 경우 암호를 재설정하여 API키를 재활성화합니다.

Managed Runtime API에는 시간 단위당 허용되는 요청 수에 대한 처리율 제한이 있습니다. 처리율 제한은 사용자별로 적용되며, 모든 사용자가 공평하게 액세스할 수 있게 해줍니다.

요청이 처리율 제한을 초과할 경우, API는 재시도할 수 있을 때까지 남은 시간(초)을 나타내는 Retry-After HTTP 헤더와 HTTP 429 Too Many Requests 오류를 반환합니다.

처리율 한도는 조정할 수 없습니다.

아래 표는 다양한 API 패밀리의 처리율 제한을 나타냅니다.

일부 엔드포인트에는 누적 처리율 제한이 적용되며, 따라서 엔드포인트별로 제한되지 않습니다. 대신, 누적 처리율 제한은 여러 엔드포인트에 걸쳐 합산한 요청 수를 제한합니다. 모든 GET 요청에는 누적 처리율 제한이 적용됩니다. 마찬가지로, 다음 표에 나열된 개별적으로 호출되지 않은 엔드포인트에 대한 모든 POST, PATCH 및 DELETE 요청에도 누적 처리율 제한이 적용됩니다. 이러한 제한은 아래에 설명되어 있습니다.
메서드엔드포인트
POST/api/projects/
PATCH/api/projects/*/
DELETE/api/projects/*/
POST/api/projects/*/builds/*/
POST/api/projects/*/target/
PATCH/api/projects/*/target/*/
DELETE/api/projects/*/target/*/
POST/api/projects/*/target/*/deploy/
누적 1분 한도누적 1시간 한도
10100
메서드엔드포인트5분 한도1시간 한도
POST/api/projects/*/target/*/invalidation/15100
메서드엔드포인트1분 한도1시간 한도
GET모든 엔드포인트 합산1,000해당 없음
POST, PATCH, DELETE모든 남은 엔드포인트 합산100해당 없음

API의 기능을 알아보고 샘플 요청도 몇 가지 실행해보았습니다.

API에 대해 자세히 알아보려면 API 사양을 참조하십시오.

API용 Open API 스키마는 다음에서 제공됩니다.