AWS Partner Central API 참조가 재구성되었습니다. 지원되는 API 작업에 대한 자세한 내용은 AWS Partner Central API 참조를 참조하세요.
기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다.
혜택 애플리케이션 작업
혜택 애플리케이션은 특정 혜택에 대한 파트너의 요청을 모델링합니다. 혜택별 조건에 따라 요청을 평가하고 처리하는 데 필요한 모든 정보를 캡처합니다. 혜택 애플리케이션 수명 주기는 초안 생성부터 최종 승인 또는 거부까지 여러 상태로 진행됩니다.
혜택 애플리케이션 생성
파트너는 CreateBenefitApplication API 작업을 사용하여 혜택 애플리케이션을 생성하여 혜택 요청 프로세스를 시작합니다. 생성 시 애플리케이션이 PENDING_SUBMISSION 상태가 되어 파트너가 검토를 위해 제출하기 전에 전체 정보를 준비할 수 있습니다.
혜택 애플리케이션을 생성할 때 파트너는 다음을 제공해야 합니다.
-
혜택 식별자 - 요청 중인 혜택의 ID 또는 ARN
-
이행 유형 - 파트너가 혜택을 받을 것으로 예상하는 방식(
CREDITS,CASH,DISCOUNT,ACCESS,RECOGNITION또는RESOURCE) -
혜택 애플리케이션 세부 정보 - 혜택의 요청 스키마에 정의된 혜택별 정보가 포함된 JSON 문서
-
클라이언트 토큰 - 중복 제출을 방지하기 위한 고유한 멱등성 토큰
파트너는 선택적으로 다음을 제공할 수 있습니다.
-
이름 및 설명 - 애플리케이션의 사람이 읽을 수 있는 식별자
-
파트너 연락처 -이 혜택 요청을 관리하는 사람의 연락처 정보(최대 1개의 연락처)
-
파일 첨부 - 프로젝트 계획, SOWs, 비용 증명 또는 고객 만족도 설문조사와 같은 지원 문서(최대 10개의 파일)
-
관련 리소스 - 관련 기회 또는 기존 혜택 할당에 대한 링크(최대 10개의 리소스)
-
태그 - 리소스 구성 및 추적을 위한 키-값 페어(최대 200개의 태그)
CreateBenefitApplication API는 소프트 검증을 수행하여 기본 필드 유형 및 패턴만 확인합니다. 전체 비즈니스 로직 검증은 제출 중에 수행되므로 파트너는 불완전한 애플리케이션을 저장하고 나중에 다시 돌아와 완료할 수 있습니다.
모범 사례: 파트너는의 혜택 요청 스키마GetBenefit를 사용하여 애플리케이션을 생성하기 전에 필요한 정보를 정확하게 이해해야 합니다. 이렇게 하면 누락되거나 잘못된 데이터로 인해 제출이 실패할 가능성이 줄어듭니다.
혜택 애플리케이션 업데이트
파트너는 UpdateBenefitApplication API 작업을 사용하여 초안 혜택 애플리케이션을 수정할 수 있습니다. 이를 통해 파트너는 제출 전에 정보를 구체화하거나, 설명서를 추가하거나, 오류를 수정할 수 있습니다.
혜택 애플리케이션을 업데이트할 때 파트너는 다음을 제공해야 합니다.
-
식별자 - 업데이트할 혜택 애플리케이션의 ID 또는 ARN입니다.
-
개정 - 낙관적 잠금을 위한 현재 개정 번호
-
혜택 애플리케이션 세부 정보 - 완전하고 업데이트된 JSON 문서
파트너는 특정 필드만 변경되더라도 전체 혜택 애플리케이션 객체를 제출해야 합니다. 모범 사례는 먼저를 사용하여 최신 애플리케이션 세부 정보를 검색하고 필요한 필드를 GetBenefitApplication수정한 다음 업데이트된 전체 페이로드를에 제출하는 것입니다UpdateBenefitApplication.
낙관적 잠금: 개정 필드는 애플리케이션이 마지막으로 검색된 이후 변경되지 않은 경우에만 업데이트가 적용되도록 합니다. 개정이 현재 데이터베이스 값과 일치하지 않으면 충돌 오류와 함께 업데이트가 거부됩니다. 이렇게 하면 파트너가 실수로 다른 프로세스 또는 시스템의 변경 사항을 덮어쓰지 않습니다.
업데이트는 애플리케이션이 PENDING_SUBMISSION 상태인 동안에만 수행할 수 있습니다. 제출된 애플리케이션은 검토 프로세스에 들어가며이 API를 통해 더 이상 업데이트할 수 없습니다.
리소스와 혜택 애플리케이션 연결
파트너는 AssociateBenefitApplicationResource API 작업을 사용하여 관련 리소스에 혜택 애플리케이션을 연결할 수 있습니다. 이렇게 하면 이점과 사용 중인 비즈니스 컨텍스트 간에 중요한 연결이 생성됩니다.
지원되는 리소스 유형은 다음과 같습니다.
-
기회 - 혜택 애플리케이션을의 특정 고객 기회에 연결합니다. 이는 고객 참여와 관련된 MAP 자금 또는 POC 크레딧과 같은 기회별 이점에 특히 유용합니다.
-
BENEFIT_ALLOCATION - 기존 혜택 할당에 연결하여 파트너가 혜택을 연결하거나 이전 혜택을 활용하는 방법을 시연할 수 있습니다.
리소스 연결은 제출 전에만 수행할 수 있습니다. 혜택 애플리케이션이 제출되면( 상태가 로 변경됨IN_REVIEW) 추가 연결은 허용되지 않습니다. 파트너는 각 혜택 애플리케이션에 최대 10개의 리소스를 연결할 수 있습니다.
파트너는 리소스를 연결 해제하기 위해 DisassociateBenefitApplicationResource API 작업을 사용합니다. 연결과 마찬가지로 연결 해제는 PENDING_SUBMISSION 상태에서만 발생할 수 있습니다.
중요
파트너는 혜택 애플리케이션에 액세스하고 연결 중인 특정 리소스를 읽을 수 있는 적절한 권한이 있어야 합니다. API는 연결 작업 중에 이러한 권한을 검증합니다.
혜택 애플리케이션 제출
혜택 애플리케이션이 완료되고AWS검토할 준비가 되면 파트너는 SubmitBenefitApplication API 작업을 사용하여 제출합니다. 제출은에서 로 상태 전환을 트리거PENDING_SUBMISSIONIN_REVIEW하고 혜택별 승인 워크플로를 시작합니다.
제출 시 API는 다음을 포함한 포괄적인 검증을 수행합니다.
-
필수 필드 검증 - 혜택 애플리케이션 세부 정보의 모든 필수 필드가 있는지 확인합니다.
-
필드 형식 검증 - 필드 값이 예상 패턴 및 데이터 유형과 일치하는지 확인합니다.
-
비즈니스 규칙 검증 - 혜택별 비즈니스 로직 및 제약 조건 적용
-
리소스 검증 - 연결된 모든 리소스가 유효하고 액세스 가능한지 확인합니다.
-
파일 검증 - 모든 파일 첨부 파일이 처리를 성공적으로 완료했는지 확인합니다.
검증에 실패하면 API는 수정이 필요한 필드를 나타내는 자세한 오류 코드 및 메시지와 함께 ValidationException을 반환합니다. 파트너는 제출을 다시 시도UpdateBenefitApplication하기 전에를 사용하여 이러한 문제를 해결해야 합니다.
파일 처리 요구 사항: 연결된 파일이 아직 PENDING 상태인 경우 혜택 애플리케이션을 제출할 수 없습니다. 파트너는 제출하기 전에 파일 처리가 완료될 때까지 기다려야 합니다(에 대한 상태 변경SUCCEEDED). 파일 처리에 실패하면( 상태FAILED) 파트너는 수정된 버전을 업로드해야 합니다.
성공적으로 제출한 후:
-
애플리케이션 상태가 로 변경됩니다.
IN_REVIEW -
혜택 소유자의 팀에 새 제출에 대한 알림이 전송됩니다.
-
파트너는 더 이상 표준 업데이트 APIs
-
애플리케이션이 비즈니스 승인, 기술 승인 및 재무 승인 단계를 포함할 수 있는 정의된 승인 워크플로에 들어갑니다.
파트너는 애플리케이션을 검색하고 현재 승인 단계를 나타내는 단계 필드(예: "비즈니스 승인", "기술 승인", "재무 승인")를 모니터링하여 제출 진행 상황을 추적할 수 있습니다.
제출된 애플리케이션 관리
제출된 파트너는 혜택 애플리케이션을 관리할 수 있는 옵션이 제한적이지만 API는 일반적인 시나리오에 대한 특정 작업을 제공합니다.
혜택 애플리케이션 리콜
파트너가 오류를 발견하거나 제출 후 변경해야 하는 경우 RecallBenefitApplication API 작업을 사용하여 애플리케이션을 리콜할 수 있습니다. 리콜은 애플리케이션을 PENDING_SUBMISSION 상태로 다시 전환하여 업데이트 및 재제출을 허용합니다.
애플리케이션을 리콜할 때 파트너는 다음을 제공해야 합니다.
-
식별자 - 리콜할 혜택 애플리케이션의 ID 또는 ARN입니다.
-
이유 - 리콜에 대한 선택적 설명(최대 1,000자)
사유 필드를 사용하면 추적 가능성을 높이고 리콜로 이어지는 일반적인 문제를AWS이해하여 향후 혜택 애플리케이션 프로세스를 개선할 수 있습니다.
리콜 후 파트너는 UpdateBenefitApplication를 사용하여 필요한 변경을 수행한 다음 준비가 SubmitBenefitApplication 되면를 사용하여 다시 제출할 수 있습니다.
중요
리콜은 일반적으로 초기 검토 단계에서만 사용할 수 있습니다. 이후 승인 단계로 진행했거나 승인된 애플리케이션은 리콜 대상이 될 수 없습니다.
혜택 애플리케이션 수정
제출 후 사소한 수정의 경우 파트너는 AmendBenefitApplication API 작업을 사용하여 전체 애플리케이션을 재현하지 않고 특정 필드를 업데이트할 수 있습니다. 이는AWS검토자가 검토 프로세스 중에 설명 또는 수정을 요청할 때 특히 유용합니다.
수정은 파트너가 다음을 지정하는 JSON 패치 스타일 접근 방식을 사용합니다.
-
경로 - 업데이트할 필드를 식별하는 JSONPath 표현식(예:
$.CreditDisbursementDetails.AwsAccountIdForCredits) -
값 - 필드의 새 값입니다.
-
작업 - 수행할 작업(현재
REPLACE는 만 지원됨)
파트너는 단일 API 호출에서 최대 10개의 수정 사항을 제출할 수 있습니다. 각 수정에는 낙관적 잠금을 위한 업데이트된 개정 번호가 포함되어야 합니다.
사소한 수정에는 수정을 사용해야 합니다. 상당한 변경의 경우 파트너는 RecallBenefitApplication를 사용하여 포괄적인 업데이트를 위해 애플리케이션을 초안 상태로 되돌려야 합니다.
혜택 애플리케이션 취소
파트너가 더 이상 도움이 필요하지 않거나 애플리케이션을 철회하려는 경우 CancelBenefitApplication API 작업을 사용하여 취소할 수 있습니다. 취소하면 애플리케이션이 CANCELED 상태로 전환되어 애플리케이션 프로세스가 영구적으로 종료됩니다.
애플리케이션을 취소할 때 파트너는 다음을 제공해야 합니다.
-
식별자 - 취소할 혜택 애플리케이션의 ID 또는 ARN입니다.
-
이유 - 취소에 대한 선택적 설명(최대 1,000자)
취소되면 애플리케이션을 다시 활성화할 수 없습니다. 파트너가 나중에 혜택이 필요하다고 결정하는 경우 새 혜택 애플리케이션을 생성해야 합니다.
취소의 일반적인 이유는 다음과 같습니다.
-
고객 기회가 손실되거나 지연됨
-
파트너 용량 제약 조건 변경됨
-
비즈니스 우선 순위 이동
-
의도한 목적에 더 이상 혜택이 필요하지 않음
혜택 애플리케이션 세부 정보 보기
파트너는 GetBenefitApplication API 작업을 사용하여 혜택 애플리케이션에 대한 전체 정보를 검색할 수 있습니다. 이를 통해 다음과 같은 애플리케이션을 포괄적으로 볼 수 있습니다.
애플리케이션 메타데이터:
-
고유 식별자(ID) 및 Amazon 리소스 이름(ARN)
-
관련 혜택 식별자
-
애플리케이션 이름 및 설명
-
현재 상태(
PENDING_SUBMISSION,IN_REVIEW,ACTION_REQUIRED,APPROVEDREJECTED, 또는CANCELED) -
현재 처리 단계
상태 정보:
-
상태 이유 - 현재 상태에 대한 사람이 읽을 수 있는 설명
-
상태 이유 코드 - 특정 문제 또는 요구 사항을 나타내는 구조화된 코드(예: "Checklist Incomplete", "Project Plan Missing", "Design Win Missing")
애플리케이션 콘텐츠:
-
전체 혜택 애플리케이션 세부 정보 JSON 문서
-
파트너 연락처 정보
-
처리 상태의 파일 첨부 파일
-
연결된 리소스(기회 또는 할당)
-
리소스 태그
감사 정보:
-
생성 타임스탬프
-
마지막 수정 타임스탬프
-
현재 개정 번호
상태 이유 코드는 애플리케이션이 ACTION_REQUIRED 상태일 때 특히 유용합니다. 이러한 코드는 파트너가 애플리케이션을 진행하기 위해 해결해야 하는 사항에 대한 구체적이고 실행 가능한 지침을 제공합니다.
혜택 애플리케이션 나열
파트너는 ListBenefitApplications API 작업을 사용하여 모든 혜택 애플리케이션을 볼 수 있습니다. 이렇게 하면 강력한 필터링 기능이 포함된 애플리케이션 요약의 페이지가 매겨진 목록이 반환됩니다.
파트너는 다음을 기준으로 애플리케이션을 필터링할 수 있습니다.
-
프로그램 - 특정 프로그램(MAP, MDF, 샌드박스, POC 등)에 대한 애플리케이션 보기
-
이행 유형 - 전송 방법(
CREDITS,CASHACCESS, 등)을 기준으로 필터링 -
혜택 식별자 - 특정 혜택에 대한 애플리케이션 보기
-
상태 - 애플리케이션 상태(
PENDING_SUBMISSION, ,IN_REVIEW,APPROVEDREJECTED,CANCELED)를 기준으로 필터링 -
단계 - 승인 단계(비즈니스 승인, 기술 승인, 재무 승인)를 기준으로 필터링
-
연결된 리소스 ARNs - 특정 기회 또는 할당에 연결된 애플리케이션 찾기
목록 응답에는 다음과 같은 필수 요약 정보가 포함됩니다.
-
애플리케이션 ID, ARN 및 이름
-
관련 혜택 ID
-
프로그램 및 이행 유형
-
현재 상태 및 단계
-
타임스탬프 생성 및 수정
-
관련 리소스
-
현재 개정 번호
-
혜택 애플리케이션 세부 정보에서 선택한 필드(복리후생 소유자가 정의)
파트너는 생성 날짜, 상태, 프로그램 또는 혜택 식별자를 기준으로 오름차순 또는 내림차순으로 정렬하는 옵션과 함께 정렬 파라미터를 사용하여 결과 정렬을 구성할 수 있습니다.
대시보드 구축: ListBenefitApplications API는 파트너 대시보드 생성을 지원하도록 설계되었습니다. 파트너는 애플리케이션을 필터링하고 정렬하여 다음과 같은 보기를 구축할 수 있습니다.
-
작업이 필요한 애플리케이션(
ACTION_REQUIRED상태) -
최근에 제출된 애플리케이션(생성 날짜,
IN_REVIEW상태별로 정렬됨) -
할당 보류 중인 승인된 애플리케이션(
APPROVED상태) -
프로그램별 애플리케이션(특정 프로그램으로 필터링됨)