Se reestructuró la referencia de la Centro de socios de AWS API. Para obtener más información sobre las operaciones de API compatibles, consulte la referencia de la Centro de socios de AWS API.

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

Trabajando con solicitudes de beneficios

Una solicitud de beneficios modela la solicitud de un socio para obtener un beneficio específico. Captura toda la información necesaria para evaluar y procesar la solicitud de acuerdo con las condiciones específicas de cada beneficio. El ciclo de vida de la solicitud de beneficios pasa por varios estados, desde la creación del borrador hasta la aprobación o el rechazo finales.

Creación de aplicaciones de beneficios

Los socios inician el proceso de solicitud de beneficios creando una solicitud de beneficios mediante la acción de la CreateBenefitApplication API. Al crearla, la solicitud pasa al PENDING_SUBMISSION estado, lo que permite a los socios preparar la información completa antes de enviarla para su revisión.

Al crear una solicitud de beneficios, los socios deben proporcionar:

De manera opcional, los socios pueden proporcionar:

La CreateBenefitApplication API realiza una validación suave y comprueba solo los tipos y patrones de campos básicos. La validación completa de la lógica empresarial se realiza durante el envío, lo que permite a los socios guardar las solicitudes incompletas y volver más tarde para completarlas.

Práctica recomendada: Los socios deben utilizar el esquema de solicitud de beneficios desde GetBenefit para comprender exactamente qué información se necesita antes de crear una solicitud. Esto reduce la probabilidad de errores en el envío debido a datos faltantes o no válidos.

Actualización de las solicitudes de beneficios

Los socios pueden modificar los borradores de las solicitudes de beneficios mediante la acción UpdateBenefitApplication de la API. Esto permite a los socios refinar la información, agregar documentación o corregir errores antes de presentarla.

Al actualizar una solicitud de beneficios, los socios deben proporcionar:

Los socios deben enviar el objeto de solicitud de beneficios completo, incluso si solo cambian campos específicos. La mejor práctica consiste en recuperar primero los detalles más recientes de la solicitudGetBenefitApplication, modificar los campos necesarios y, a continuación, enviar la carga útil completa y actualizada aUpdateBenefitApplication.

Bloqueo optimista: el campo de revisión garantiza que las actualizaciones se apliquen solo si la aplicación no ha cambiado desde la última vez que se recuperó. Si la revisión no coincide con el valor actual de la base de datos, la actualización se rechaza y se produce un error de conflicto. Esto evita que los socios sobrescriban accidentalmente los cambios realizados por otros procesos o sistemas.

Las actualizaciones solo se pueden realizar mientras la aplicación está en PENDING_SUBMISSION estado. Una vez enviadas, las solicitudes pasan al proceso de revisión y ya no se pueden actualizar a través de esta API.

Asociar los recursos a las solicitudes de beneficios

Los socios pueden vincular las solicitudes de beneficios a los recursos relacionados mediante la acción de la AssociateBenefitApplicationResource API. Esto crea conexiones valiosas entre los beneficios y el contexto empresarial en el que se utilizan.

Los tipos de recursos admitidos son:

La asociación de recursos solo puede producirse antes del envío. Una vez que se presenta una solicitud de prestación (el estado cambia aIN_REVIEW), no se permiten más asociaciones. Los socios pueden asociar hasta 10 recursos a cada solicitud de beneficios.

Para desvincular un recurso, los socios utilizan la acción de la DisassociateBenefitApplicationResource API. Al igual que la asociación, la disociación solo se puede producir en el PENDING_SUBMISSION estado.

Presentación de solicitudes de beneficios

Cuando una solicitud de beneficios está completa y lista para su AWS revisión, los socios la envían mediante la acción de la SubmitBenefitApplication API. La presentación desencadena una transición de estado de PENDING_SUBMISSION a IN_REVIEW e inicia el flujo de trabajo de aprobación específico de los beneficios.

Tras el envío, la API realiza una validación exhaustiva que incluye:

Si la validación falla, la API devuelve códigos de ValidationException error detallados y mensajes que indican qué campos deben corregirse. Los socios deben solucionar estos problemas UpdateBenefitApplication antes de volver a intentar el envío.

Requisito de procesamiento de archivos: las solicitudes de beneficios no se pueden enviar si los archivos adjuntos aún están en PENDING estado. Los socios deben esperar a que se complete el procesamiento de los archivos (el estado cambia aSUCCEEDED) antes de enviarlos. Si los archivos no se procesan (estadoFAILED), los socios deben subir las versiones corregidas.

Tras el envío exitoso:

Los socios pueden hacer un seguimiento del progreso de la presentación recuperando la solicitud y supervisando el campo Fase, que indica la fase de aprobación actual (por ejemplo, «aprobación empresarial», «aprobación técnica» o «aprobación financiera»).

Gestión de las solicitudes presentadas

Una vez presentadas, los socios tienen opciones limitadas para administrar las solicitudes de beneficios, pero la API proporciona acciones específicas para escenarios comunes.

Recordando las solicitudes de beneficios

Si un socio descubre un error o necesita hacer cambios después de enviarla, puede retirar la solicitud mediante la acción de la RecallBenefitApplication API. La recuperación devuelve la solicitud al PENDING_SUBMISSION estado, lo que permite actualizarla y volver a enviarla.

Al retirar una solicitud, los socios deben proporcionar:

El campo del motivo permite una mejor trazabilidad y ayuda a AWS comprender los problemas comunes que provocan las retiradas del mercado, lo que sirve de base para futuras mejoras en el proceso de solicitud de prestaciones.

Tras la retirada, los socios pueden utilizarla UpdateBenefitApplication para hacer los cambios necesarios y volver a enviarla SubmitBenefitApplication cuando estén listos.

Modificación de las solicitudes de beneficios

En el caso de correcciones menores una vez presentadas, los socios pueden usar la acción de la AmendBenefitApplication API para actualizar campos específicos sin tener que recuperar toda la solicitud. Esto resulta especialmente útil cuando AWS los revisores solicitan aclaraciones o correcciones durante el proceso de revisión.

Las enmiendas utilizan un Patch-style enfoque JSON en el que los socios especifican:

Los socios pueden enviar hasta 10 modificaciones en una sola llamada a la API. Cada modificación debe incluir un número de revisión actualizado para lograr un bloqueo optimista.

Las enmiendas deben usarse para correcciones menores. En el caso de cambios sustanciales, los socios deben RecallBenefitApplication utilizar la opción de devolver la solicitud al estado de borrador para obtener actualizaciones exhaustivas.

Cancelación de las solicitudes de beneficios

Si un socio ya no necesita una prestación o desea retirar su solicitud, puede cancelarla mediante la acción de la CancelBenefitApplication API. La cancelación hace que la solicitud pase a estar en CANCELED estado, lo que pone fin de forma permanente al proceso de solicitud.

Al cancelar una solicitud, los socios deben proporcionar:

Una vez canceladas, las aplicaciones no se pueden reactivar. Si el socio decide más adelante que necesita el beneficio, debe crear una nueva solicitud de beneficio.

Entre los motivos más comunes de cancelación se incluyen los siguientes:

Ver los detalles de la solicitud de beneficios

Los socios pueden recuperar la información completa sobre una solicitud de beneficios mediante la acción de la GetBenefitApplication API. Esto proporciona una visión completa de la solicitud, que incluye:

Metadatos de la aplicación:

Información de estado:

Contenido de la aplicación:

Información de auditoría:

Los códigos de motivo de estado son especialmente valiosos cuando una solicitud está en ACTION_REQUIRED estado. Estos códigos proporcionan una guía específica y práctica sobre lo que los socios deben abordar para que la solicitud continúe.

Listado de solicitudes de beneficios

Los socios pueden ver todas sus solicitudes de beneficios mediante la acción de la ListBenefitApplications API. Esto devuelve una lista paginada de resúmenes de aplicaciones con potentes funciones de filtrado.

Los socios pueden filtrar las solicitudes según:

La respuesta a la lista incluye información resumida esencial, como:

Los socios pueden configurar la clasificación de los resultados mediante el parámetro de clasificación, con opciones para ordenar por fecha de creación, estado, programa o identificador de beneficio en orden ascendente o descendente.

Creación de paneles: la ListBenefitApplications API está diseñada para facilitar la creación de paneles para socios. Al filtrar y ordenar las aplicaciones, los socios pueden crear vistas como: