Paradigm: API Network Partner Framework

Owned by Subrat Sandilya
Last updated: Sept 04, 2024 by Rajeev Rai
2 min read

Use Case Overview

The client posts the bill JSON to Adeptia through the Adeptia generated API. Subsequently, the bill data is inserted into the filequeue and billdetails table, categorized by partnerID.The processed data is then forwarded to ADVA in a single bill file using ASB Queue.

ADVA evaluates the bill and returns the priced JSON, containing details that are then integrated into the billdetail table. The status is modified to "PRICE RECEIVED".Upon this status update, the client triggers another API request to retrieve pricing information associated with the partnerID using the externalBillID and the AdvaPRO KEY (partnerID).

Object Zip: Click here

Design Overview

A. Inbound Process Parent - PC_PF_SubmitBill_MainProcess_API

  • The API endpoint named Adeptia (PC_RP_SubmitBill_API) is accessed by the client to submit the Bill JSON using the partner-specific API Key (PartnerID). The submitted data is then saved in both the filequeue and billdetails tables, with the ResponseCode being set to 200.

  • For Filequeue the status is “File Received”

  • For Bill Details the status is “Bill Submitted”

  • Thereafter the parent process calls the child process.

A.1 Inbound Process Child - PC_PF_SubmitBill_SubProcess_API

  • When the ResponseCode is 200, the billJSON provided by a client is forwarded to ADVA via ASB for Pricing.

B. ConsumeAdvaProResponse Process

  • Trigger: A Calendar Event triggers this process based on the partnerID.

  • Process: AdvaPro will provide the pricing by fetching it from ASB and then inserting the price data into the "priceDetails" column within the BillDetails table. This action applies to all bills that have received pricing, with the status in the BillDetails table marked as "Price Received".

C. Outbound Process Parent - PC_PF_MainProcess_BillStatus_API

  • Using the API Key (PC_RP_RequestBillStatus_API), the client accesses the API to retrieve the current status of the bill from the solution database (Billdetail table).

Solution Architecture:

  • Create an Inbound Parent Process Flow activity: PC_PF_SubmitBill_MainProcess_API

  • Create an Inbound Child Process Flow activity: PC_PF_SubmitBill_SubProcess_API

  • Create an Outbound Parent Process Flow activity: PC_PF_MainProcess_BillStatus_API

  • Create an Outbound Child Process Flow activity: PC_PF_SubProcess_BillStatus_API

  • API Partner Creation

  • ConsumeAdvaProResponse Process

Pre-requisite:

  • Paradigm Objects - Click Here to Download (Deploy the object in local/Training Environment)

  • Create an API Partner.

  • Create a Solution DB.

API Partner File Processing Order:

  • Inbound Process to update bill information in filequeue / billdetails table.

  • Child Process to send the bill to ADVA for Pricing

  • Consume ASB Process to consume the bills shared by ADVA