Se reestructuró la referencia de la Centro de socios de AWS API. Para obtener más información sobre las operaciones de API compatibles, consulta 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.

Trabajar con las solicitudes de prestaciones

Una solicitud de beneficios modela la solicitud de un socio para un beneficio específico. Captura toda la información necesaria para evaluar y procesar la solicitud de acuerdo con las condiciones específicas de la prestación. El ciclo de vida de las solicitudes de beneficios progresa en varios estados, desde la creación del borrador hasta su aprobación o rechazo final.

Creación de solicitudes de prestaciones

Los socios inician el proceso de solicitud de beneficios creando una solicitud de beneficios mediante la acción de la CreateBenefitApplication API. Al crearse, la solicitud entra en 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 prestaciones, los socios deben proporcionar:

Los socios pueden proporcionar opcionalmente:

La CreateBenefitApplication API realiza una validación suave y comprueba solo los tipos y patrones de campo básicos. La validación completa de la lógica empresarial se produce 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 prestaciones GetBenefit para saber exactamente qué información se necesita antes de crear una solicitud. Esto reduce la probabilidad de que se produzcan errores en la presentación debido a la falta de datos o a la invalidez de los datos.

Actualización de las solicitudes de prestaciones

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

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

Los socios deben enviar el objeto completo de la solicitud de prestaciones, aunque solo cambien 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 actualizada aUpdateBenefitApplication.

Bloqueo optimista: el campo de revisión garantiza que las actualizaciones solo se apliquen 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 entran en el proceso de revisión y ya no se pueden actualizar a través de esta API.

Asociar los recursos con las solicitudes de prestaciones

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 tener lugar 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 prestación.

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

Presentación de solicitudes de prestaciones

Cuando una solicitud de prestaciones 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 PENDING_SUBMISSION a IN_REVIEW e inicia el flujo de trabajo de aprobación de prestaciones específicas.

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

Si se produce un error en la validación, la API devuelve un mensaje ValidationException con códigos de error detallados que indican qué campos deben corregirse. Los socios deben abordar estos problemas UpdateBenefitApplication antes de volver a intentar enviarlos.

Requisito de procesamiento de archivos: las solicitudes de prestaciones no se pueden enviar si aún hay archivos adjuntos 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 cargar las versiones corregidas.

Tras el envío correcto:

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 gestionar las solicitudes de prestaciones, pero la API proporciona acciones específicas para situaciones comunes.

¿Recordando las solicitudes de prestaciones

Si un socio descubre un error o necesita realizar cambios después del envío, puede recuperar la aplicación mediante la acción de la RecallBenefitApplication API. Recall hace que la solicitud vuelva a PENDING_SUBMISSION su estado, lo que permite actualizarla y volver a enviarla.

Al recuperar una solicitud, los socios deben proporcionar:

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

Tras la retirada, los socios pueden utilizarlos UpdateBenefitApplication para realizar los cambios necesarios y volver a enviarlos SubmitBenefitApplication cuando estén preparados.

Modificación de las solicitudes de prestaciones

Para realizar correcciones menores tras el envío, los socios pueden utilizar 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 garantizar un cierre optimista.

Las enmiendas deben utilizarse para correcciones menores. En el caso de cambios sustanciales, los socios deberían volver RecallBenefitApplication a poner la solicitud en estado de borrador para obtener actualizaciones exhaustivas.

Cancelar las solicitudes de prestaciones

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 convierte la solicitud 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.

Los motivos más comunes de cancelación incluyen:

Ver los detalles de la solicitud de beneficios

Los socios pueden recuperar la información completa sobre una solicitud de prestaciones 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 solicitud:

Información de auditoría:

Los códigos de motivo de estado son particularmente 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 se tramite la solicitud.

Listado de solicitudes de prestaciones

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 por:

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 Ordenar, con opciones para ordenar por fecha de creación, estado, programa o identificador de prestación en orden ascendente o descendente.

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