Guía de Migración

Esta guía describe los cambios que debe esperar al migrar de a ODS Inquiry API V3 de V2.

Ver la lista completa y detallada de cambios en comparación con V2 para obtener información más detallada.

Cambios en la Especificación

La Consulta V3 API fue introducido para consolidar los cuatro views/summaries puntos finales a uno, con journeyType convirtiéndose en un parámetro de búsqueda en lugar de un parámetro de URL. Se han realizado los siguientes cambios:

  • Todos los puntos finales han sido actualizados para tener una ruta que comience con /api/v3. Por ejemplo:

    • /api/v2/views/details/{unitOfWorkId}→`/api/v3/views/details/{unitOfWorkId}`

    • /api/v2/catalogue/process-objects/message-logs→`/api/v3/catalogue/process-objects/message-logs`

    • etc.

  • Los cuatro /views/summaries/ los puntos finales de búsqueda han sido unificados. Anteriormente, estos cuatro API los endpoints tenían journeyType como un parámetro de URL, ahora es un parámetro de consulta. Por ejemplo:

    • /api/v2/views/summaries/payments→`/api/v3/views/summaries?journeyType=PAYMENT`

    • /api/v2/views/summaries/recalls→`/api/v3/views/summaries?journeyType=RECALL`

  • Lo que significa que estos puntos finales han sido eliminados:

    • /views/summaries/payments

    • /views/summaries/recalls

    • /views/summaries/batches

    • /views/summaries/bulks

  • La clase de respuesta para todos /api/v3/all/mds-objects y /api/v3/catalogue/mds-objects/ los endpoints han cambiado a MdsObjectSearchItem, eliminando el uso de las clases distintas:

    • MdsObjectSearchItem

    • Pacs008FIToFICustomerCreditTransferMdsSearchItem

    • Pacs008CreditTransferTransactionMdsSearchItem

    • Pacs002FIToFIPaymentStatusReportMdsSearchItem

    • Pacs002OriginalGroupHeaderMdsSearchItem

    • Pacs002PaymentTransactionMdsSearchItem

    • Pacs004PaymentReturnMdsSearchItem

    • Pacs004PaymentTransactionMdsSearchItem

    • Pacs009FinancialInstitutionCreditTransferMdsSearchItem

    • Pacs009CreditTransferTransactionMdsSearchItem

    • Pacs028FIToFIPaymentStatusRequestMdsSearchItem

    • Pacs028OriginalGroupInformationMdsSearchItem

    • Pacs028PaymentTransactionMdsSearchItem

    • Pain001CustomerCreditTransferInitiationMdsSearchItem

    • Pain001PaymentInstructionMdsSearchItem

    • Pain001CreditTransferTransactionMdsSearchItem

    • Pain002CustomerPaymentStatusReportMdsSearchItem

    • Pain002OriginalPaymentInstructionMdsSearchItem

    • Pain002PaymentTransactionMdsSearchItem

    • Camt027ClaimNonReceiptMdsSearchItem

    • Camt029ResolutionOfInvestigationMdsSearchItem

    • Camt029PaymentTransactionWithResolutionMdsSearchItem

    • Camt029UnderlyingTransactionMdsSearchItem

    • Camt054BankToCustomerDebitCreditNotificationMdsSearchItem

    • Camt054AccountNotificationMdsSearchItem

    • Camt056FIToFIPaymentCancellationRequestMdsSearchItem

    • Camt056PaymentTransactionMdsSearchItem

    • Camt056UnderlyingTransactionMdsSearchItem

    • Camt087RequestToModifyPaymentMdsSearchItem

  • La estructura y la respuesta del API manténgase consistente con la implementación V2. Esto afecta a los siguientes puntos finales:

    • /api/v3/all/mds-objects

    • /api/v3/all/mds-objects/{odsObjectId}

    • /api/v3/all/mds-objects/{mdsObjectId}/history

    • /api/v3/catalogue/mds-objects/PACS_008

    • /api/v3/catalogue/mds-objects/PACS_008_CREDIT_TRANSFER_TRANSACTION

    • /api/v3/catalogue/mds-objects/PACS_002

    • /api/v3/catalogue/mds-objects/PACS_002_ORIGINAL_GROUP_HEADER

    • /api/v3/catalogue/mds-objects/PACS_002_PAYMENT_TRANSACTION

    • /api/v3/catalogue/mds-objects/PACS_004

    • /api/v3/catalogue/mds-objects/PACS_004_PAYMENT_TRANSACTION

    • /api/v3/catalogue/mds-objects/PACS_009

    • /api/v3/catalogue/mds-objects/PACS_009_CREDIT_TRANSFER_TRANSACTION

    • /api/v3/catalogue/mds-objects/PACS_028

    • /api/v3/catalogue/mds-objects/PACS_028_ORIGINAL_GROUP_INFORMATION

    • /api/v3/catalogue/mds-objects/PACS_028_PAYMENT_TRANSACTION

    • /api/v3/catalogue/mds-objects/PAIN_001

    • /api/v3/catalogue/mds-objects/PAIN_001_PAYMENT_INSTRUCTION

    • /api/v3/catalogue/mds-objects/PAIN_001_CREDIT_TRANSFER_TRANSACTION

    • /api/v3/catalogue/mds-objects/PAIN_002

    • /api/v3/catalogue/mds-objects/PAIN_002_ORIGINAL_PAYMENT_INSTRUCTION

    • /api/v3/catalogue/mds-objects/PAIN_002_PAYMENT_TRANSACTION

    • /api/v3/catalogue/mds-objects/CAMT_027

    • /api/v3/catalogue/mds-objects/CAMT_029

    • /api/v3/catalogue/mds-objects/CAMT_029_PAYMENT_TRANSACTION_WITH_RESOLUTION

    • /api/v3/catalogue/mds-objects/CAMT_029_UNDERLYING_TRANSACTION

    • /api/v3/catalogue/mds-objects/CAMT_054

    • /api/v3/catalogue/mds-objects/CAMT_054_ACCOUNT_NOTIFICATION

    • /api/v3/catalogue/mds-objects/CAMT_056

    • /api/v3/catalogue/mds-objects/CAMT_056_PAYMENT_TRANSACTION

    • /api/v3/catalogue/mds-objects/CAMT_056_UNDERLYING_TRANSACTION

    • /api/v3/catalogue/mds-objects/CAMT_087

Cambios en las Dependencias

Todo el código relacionado con ODS Inquiry API V3 ahora se encuentra bajo diferentes coordenadas de maven en comparación con V1 y V2. APIs; El groupId ha cambiado a com.iconsolutions.ipf.ods.inquiry.v3, y todos los artifactIds ahora están precedidos por ipf, por ejemplo.ods-inquiry-api se convierte ipf-ods-inquiry-api.

A continuación se presenta la lista completa de dependencias que puede esperar utilizar:

<dependency>
    <groupId>com.iconsolutions.ipf.ods.inquiry.v3</groupId>
    <artifactId>ipf-ods-inquiry-api</artifactId>
</dependency>
<dependency>
    <groupId>com.iconsolutions.ipf.ods.inquiry.v3</groupId>
    <artifactId>ipf-ods-inquiry-client-api</artifactId>
</dependency>
<dependency>
    <groupId>com.iconsolutions.ipf.ods.inquiry.v3</groupId>
    <artifactId>ipf-ods-inquiry-client-connector</artifactId>
</dependency>

Cambios en el Paquete

Todo el código relacionado con ODS Inquiry API V3, tanto generado como no generado, vive en su propio v3 paquete. Cualquier cosa previamente bajo com.iconsolutions.ipf.ods.inquiry.* ahora vive bajo com.iconsolutions.ipf.ods.inquiry.v3.*.

Los nombres de tipo permanecen mayormente sin cambios, con una excepción en el conector del cliente que se detalla a continuación en Cambios en el Conector del Cliente, lo que significa que una búsqueda-reemplazo del paquete debería llevarle la mayor parte del camino en la migración.

Cambios en el Modelo

Todo el código generado se genera en el paquete com.iconsolutions.ipf.ods.inquiry.v3.*. Al migrar de V2 de una sola vez, puede buscar y reemplazar todos los usos de com.iconsolutions.ipf.ods.inquiry.\* paquetes y reemplácelos con el equivalente v3.

Estos tipos se volvieron más estrictos, donde los campos se hicieron no nulos:

Tipo Campos Convertidos en No Nulos

com.iconsolutions.ipf.ods.inquiry.v3.model. OdsObjectHeaders

createdAt,clientRequestId,objectType,processingEntity,unitOfWorkId

com.iconsolutions.ipf.ods.inquiry.v3.model. IPFMessageLogPayload

content

com.iconsolutions.ipf.ods.inquiry.v3.model. IPFMessageLogPayload

content

com.iconsolutions.ipf.ods.inquiry.v3.model. IPFProcessFlowEvent

rawContent

com.iconsolutions.ipf.ods.inquiry.v3.model. IPFProcessFlowDefinition

rawContent

com.iconsolutions.ipf.ods.inquiry.v3.model. PdsObjectSearchItem

links

com.iconsolutions.ipf.ods.inquiry.v3.model. PdsObjectODSObject

payload

com.iconsolutions.ipf.ods.inquiry.v3.model. MdsObjectSearchItem

links

com.iconsolutions.ipf.ods.inquiry.v3.model. MdsObjectODSObject

payload

com.iconsolutions.ipf.ods.inquiry.v3.model. MdsObjectPayload

content,type

com.iconsolutions.ipf.ods.inquiry.v3.model. DetailView

createdAt,unitOfWorkId,terminal,failure

com.iconsolutions.ipf.ods.inquiry.v3.model. PdsData

content

com.iconsolutions.ipf.ods.inquiry.v3.model. EventSummaryView

processFlowDefinitionId

Estos tipos ganaron nuevos campos en comparación con el equivalente V2:

Tipo Campos Agregados

com.iconsolutions.ipf.ods.inquiry.v3.model. IPFProcessFlowEvent

hash,terminalIndicator,labels

com.iconsolutions.ipf.ods.inquiry.v3.model. IPFProcessFlowDefinition

terminalGlobalStates,states,events,rawContent

com.iconsolutions.ipf.ods.inquiry.v3.model. MdsObjectPayload

metadata,type,version,messageDefinition,content

com.iconsolutions.ipf.ods.inquiry.v3.model. OdsObjectHeaders

associationId

Estos tipos de campos perdidos en comparación con el equivalente V2:

Tipo Campos eliminados

com.iconsolutions.ipf.ods.inquiry.v3.model. OdsObjectHeaders

version,class,primaryAssociation

com.iconsolutions.ipf.ods.inquiry.v3.model. SummaryView

class

com.iconsolutions.ipf.ods.inquiry.v3.model. MdsObjectPayload

mdsContentType

Estos tipos contienen campos que cambiaron de tipo en comparación con el equivalente de V2:

Tipo Campos Cambiados

com.iconsolutions.ipf.ods.inquiry.v3.model. PdaData

version cambiado de un tipo de cadena a un entero

Cambios en el Conector del Cliente

Anteriormente, los usos del conector de consulta del cliente debían ser migrados de una sola vez, pero ahora es posible ejecutar tanto los conectores de cliente v2 como los conectores de cliente v3 juntos, lo que significa que la migración puede ser más gradual. Simplemente dependa de los conectores de cliente v3 además de los conectores de cliente v2.

Tipo Notas

com.iconsolutions.ipf.ods.inquiry.v3.model. PdsObjects

Los tipos de solicitudes del cliente GetPdsByUnitOfWorkIdRequest,GetPdsByOdsObjectIdRequest y GetPdsHistoryByPdsObjectIdRequest reemplazar los tipos V2 GetPdsObjectsRequest,GetPdsObjectRequest,GetPdsRequest,GetHistoryRequest,GetPdsHistoryRequest, esto fue para alinear el API’s con el resto de la ODS tipo de objeto API’s.