Infusion And Processing APIs

Infusion-Processing API

The API provides information about the Infusion-Processing details from the ICS account.

Introduction

The Infusion-Processing API allows to fetch/initiate details from ICS account. Infusion-Processing AP is secured by OAuth token validation, allowing customer to access any or all the following depending on the API use case:
1. Fetch all Infusion-Processing details.
2. Fetch Infusion-Processing details with specific query parameters.
3. Create/complete Infusion record.
4. Create/complete Processing record.
5. Update Infusion-Processing record.

Overview

The Infusion-Processing API is a REST-based solution that deals secure and convenient customer and business access to Infusion-Processing data.
The Infusion-Processing API is secured by Mule OAuth
The Infusion-Processing API provides information about the Infusion-Processing details from the ICS. It has below endpoints
/Ping: This endpoint returns API health.
This endpoint consists of GET method, which gives the health status of the API.
/Infusion: This endpoint returns Infusion details from the ICS.
/processing: This endpoint returns processing details from the ICS.
This endpoint consists of GET, PUT, POST methods, these are used to fetch, create and complete the Infusion process.
1. When create infusion request is passed from the request it initiates Infusion record.
2. When complete infusion request is passed from the request it initiates complete Infusion record.
3. When processing requests are passed from the request it initiates processing record.
4. When complete processing request are passed from the request it initiates complete processing record.
5. When specific queryParams are passed to fetch particular Infusion-Processing details user can pass on search criteria.
GET: This method returns Infusion-Processing details by using below query parameters.
1.partnerName: It is a mandatory field used for querying the Infusion-Processing details.
2. recordType: It is a non-mandatory field used for querying the Infusion-Processing details.
3. icsSFDCId: It is a non-mandatory field used for querying the Infusion-Processing details.
3. sourceSystem: It is optional parameter (sourceSystem can be passed along with combination of icsSFDCId) used for querying the Infusion-Processing details.
4. icsBatchName: This is optional parameter used for querying the Infusion-Processing details.
5. sourceSystemBatchId: This is the ICS Infusion-Processing ID generated by the ICS system. This is an optional field used for querying the Infusion-Processing details.
6.pageNumber: It is an optional field used for querying the Infusion-Processing details with specific page number.
PUT: This method complete Infusion-Processing details in ICS system as a result infused batch/processed batch is created. While creating complete Infusion-Processing records below are the validation performed.
1.The partnerName,sourceSystem,sourceSystemBatchId and required parameters need to be passed.
2.The required fields to be passed for respective Infusion-Processings. for instance: oldPackageDetails, equipments, newPackageDetails, actualIngredientsUsed need to be passed while creating a
Infusion-Processing .
3.The details of specific record can also be modified/updated by using same method,user need to pass sourceSystemBatchId of particular record.
POST: This method Infusion-Processing details in ICS system as a result infusion batch/ processing batch is created. While creating Infusion-Processing records below are the validation performed.
1.The partnerName,sourceSystem,sourceSystemBatchId,processingType/recordType and required parameters need to be passed.
2.The required fields to be passed for respective Infusion-Processings. for instance: PackageDetails, equipments, Ingredients need to be passed while creating a Infusion-Processing .
3.The details of specific record can also be modified/updated by using same method,user need to pass sourceSystemBatchId of particular record.

Key features and benefits

The following are features and benefits of the Infusion-Processing AP:
1. Provides access to account details including token validation.
2. Puts your customers in control of their data sharing permissions and grants through our Security.

How it works

The following diagram illustrates how the Infusion-Processing AP works.

1. The customer sends client ID and Secret requesting authorization token to access Mule APi.
2. Mule API sends the secure token.
3. The customer enters their secure token and valid Json request for specific Infusion-Processing type.
4. Mule OAuth provider processes the customer credentials and token to determine the authorization.
5. If the access is successful, the request is passed from Mule Api to ICS.
6. Response received from ICS is captured.
7. Mule API sends the response back to the customer in Json format.
8. If there is any error in the flow or validation error, Mule API handles and reverts the specific error with the customer along with standard error codes.

Use cases.
The Infusion-Processing AP supports data access for the following use cases.