L' AWS Partner Central API Reference è stato ristrutturato. Per ulteriori informazioni sulle operazioni API supportate, consulta l'AWS Partner Central API Reference.

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

Lavorare con Benefit Applications

Un'applicazione Benefit modella la richiesta di un partner per un vantaggio specifico. Raccoglie tutte le informazioni necessarie per valutare ed elaborare la richiesta in base alle condizioni specifiche dei vantaggi. Il ciclo di vita della domanda di benefit passa attraverso diversi stati, dalla creazione della bozza all'approvazione o al rifiuto finale.

Creazione di domande Benefit

I partner avviano il processo di richiesta dei benefit creando una domanda di benefit utilizzando l'azione CreateBenefitApplication API. Al momento della creazione, la domanda diventa PENDING_SUBMISSION statutaria, consentendo ai partner di preparare informazioni complete prima di inviarle per la revisione.

Quando creano una domanda di benefit, i partner devono fornire:

I partner possono fornire facoltativamente:

L'CreateBenefitApplicationAPI esegue una validazione software, controllando solo i tipi e i modelli di campo di base. La convalida completa della logica aziendale avviene durante l'invio, consentendo ai partner di salvare le domande incomplete e tornare successivamente per completarle.

Procedura consigliata: i partner devono utilizzare lo schema di richiesta dei vantaggi GetBenefit per comprendere esattamente quali informazioni sono richieste prima di creare una domanda. Ciò riduce la probabilità di errori di invio dovuti a dati mancanti o non validi.

Aggiornamento delle applicazioni Benefit

I partner possono modificare le bozze delle domande di benefit utilizzando l'azione UpdateBenefitApplication API. Ciò consente ai partner di perfezionare le informazioni, aggiungere documentazione o correggere gli errori prima dell'invio.

Quando aggiornano una domanda di benefit, i partner devono fornire:

I partner devono inviare l'oggetto completo della domanda di benefit, anche se cambiano solo campi specifici. La procedura migliore è recuperare innanzitutto i dettagli più recenti della domanda utilizzandoGetBenefitApplication, modificare i campi necessari, quindi inviare il payload completo aggiornato a. UpdateBenefitApplication

Blocco ottimistico: il campo di revisione garantisce che gli aggiornamenti vengano applicati solo se l'applicazione non è cambiata dall'ultima volta che è stata recuperata. Se la revisione non corrisponde al valore corrente del database, l'aggiornamento viene rifiutato con un errore di conflitto. Ciò impedisce ai partner di sovrascrivere accidentalmente le modifiche apportate da altri processi o sistemi.

Gli aggiornamenti possono essere eseguiti solo mentre l'applicazione è attiva. PENDING_SUBMISSION Una volta inviate, le candidature entrano nel processo di revisione e non possono più essere aggiornate tramite questa API.

Associazione delle risorse alle applicazioni Benefit

I partner possono collegare le applicazioni Benefit alle risorse correlate utilizzando l'azione AssociateBenefitApplicationResource API. Questo crea connessioni preziose tra i benefit e il contesto aziendale in cui vengono utilizzati.

I tipi di risorsa supportati includono:

L'associazione delle risorse può avvenire solo prima dell'invio. Una volta inviata una domanda di benefit (lo stato cambia inIN_REVIEW), non sono consentite ulteriori associazioni. I partner possono associare fino a 10 risorse a ciascuna domanda di benefit.

Per dissociare una risorsa, i partner utilizzano l'azione DisassociateBenefitApplicationResource API. Come l'associazione, la dissociazione può avvenire solo nello PENDING_SUBMISSION stato.

Invio di domande di benefit

Quando una domanda di benefit è completa e pronta per essere AWS esaminata, i partner la inviano utilizzando l'azione SubmitBenefitApplication API. L'invio attiva una transizione di stato da PENDING_SUBMISSION a IN_REVIEW e avvia il flusso di lavoro di approvazione specifico per il benefit.

Al momento dell'invio, l'API esegue una convalida completa, che include:

Se la convalida ha esito negativo, l'API restituisce un messaggio ValidationException con codici di errore e messaggi dettagliati che indicano quali campi devono essere corretti. I partner devono risolvere questi problemi utilizzando UpdateBenefitApplication prima di tentare nuovamente l'invio.

Requisiti per l'elaborazione dei file: le domande di benefit non possono essere inviate se i file allegati sono ancora in PENDING stato. I partner devono attendere il completamento dell'elaborazione dei file (lo stato passa aSUCCEEDED) prima di inviarli. Se l'elaborazione dei file non riesce (statoFAILED), i partner devono caricare le versioni corrette.

Dopo l'invio riuscito:

I partner possono tenere traccia dell'avanzamento dell'invio recuperando la domanda e monitorando il campo Fase, che indica la fase di approvazione corrente (ad esempio, «Business Approval», «Tech Approval», «Finance Approval»).

Gestione delle domande inviate

Una volta inviate, i partner hanno opzioni limitate per la gestione delle domande di benefit, ma l'API fornisce azioni specifiche per scenari comuni.

Richiamo delle domande di benefit

Se un partner rileva un errore o deve apportare modifiche dopo l'invio, può richiamare la domanda utilizzando l'RecallBenefitApplicationazione API. Recall riporta la domanda allo PENDING_SUBMISSION stato, consentendone gli aggiornamenti e l'invio nuovamente.

Quando richiamano una domanda, i partner devono fornire:

Il campo relativo al motivo consente una migliore tracciabilità e aiuta a AWS comprendere i problemi più comuni che portano ai richiami, indicando eventuali miglioramenti futuri del processo di richiesta delle prestazioni.

Dopo il richiamo, i partner possono utilizzarlo UpdateBenefitApplication per apportare le modifiche necessarie e inviarlo nuovamente utilizzando quando sono pronti. SubmitBenefitApplication

Modifica delle domande di indennità

Per correzioni minori dopo l'invio, i partner possono utilizzare l'azione AmendBenefitApplication API per aggiornare campi specifici senza richiamare l'intera applicazione. Ciò è particolarmente utile quando AWS i revisori richiedono chiarimenti o correzioni durante il processo di revisione.

Le modifiche utilizzano un Patch-style approccio JSON in cui i partner specificano:

I partner possono inviare fino a 10 modifiche in una singola chiamata API. Ogni modifica deve includere un numero di revisione aggiornato per un blocco ottimistico.

Gli emendamenti devono essere utilizzati per correzioni minori. In caso di modifiche sostanziali, i partner dovrebbero RecallBenefitApplication riportare la domanda allo stato di bozza per aggiornamenti completi.

Annullamento delle domande di benefit

Se un partner non ha più bisogno di un benefit o desidera ritirare la propria domanda, può annullarla utilizzando l'azione CancelBenefitApplication API. L'annullamento fa passare la domanda allo CANCELED status, interrompendo definitivamente il processo di candidatura.

Quando si annulla una candidatura, i partner devono fornire:

Una volta annullate, le applicazioni non possono essere riattivate. Se in seguito il partner decide di aver bisogno del benefit, deve creare una nuova domanda di benefit.

I motivi più comuni di cancellazione includono:

Visualizzazione dei dettagli della domanda di Benefit

I partner possono recuperare informazioni complete su una domanda di benefit utilizzando l'azione GetBenefitApplication API. Ciò fornisce una visione completa dell'applicazione, tra cui:

Metadati dell'applicazione:

Informazioni sullo stato:

Contenuto dell'applicazione:

Informazioni sull'audit:

I codici dei motivi dello stato sono particolarmente utili quando una domanda è in ACTION_REQUIRED stato. Questi codici forniscono indicazioni specifiche e attuabili su ciò che i partner devono affrontare affinché la candidatura proceda.

Elenco delle domande relative ai vantaggi

I partner possono visualizzare tutte le loro domande di benefit utilizzando l'azione ListBenefitApplications API. Ciò restituisce un elenco suddiviso in pagine di riepiloghi delle applicazioni con potenti funzionalità di filtro.

I partner possono filtrare le applicazioni in base a:

La risposta all'elenco include informazioni di riepilogo essenziali come:

I partner possono configurare l'ordinamento dei risultati utilizzando il parametro Sort, con opzioni per ordinare per data di creazione, stato, programma o identificatore del benefit in ordine crescente o decrescente.

Creazione di dashboard: l'ListBenefitApplicationsAPI è progettata per supportare la creazione di dashboard per i partner. Filtrando e ordinando le applicazioni, i partner possono creare visualizzazioni come: