SPL Digital Transformation
Solution Low Level Design Document
InterOps
APIs Integration
Date: Dec 13th 2024
Version: 1.0
Amendment History
Version Date Author Organization Log
Dung Pham Tien, Long Tran
1.0 Mar 24th 2025 SPL Added new
Bao
Approval List
Date Name Department Version Sign
th 2025 Dong Truong Thanh SPL 1.0
Distribution List
Name Department
InfinitePL | Solution Low Level Design
Table of Contents
1. OVERVIEW............................................................................................................................................... 4
2. INTRODUCTION ....................................................................................................................................... 4
2.1. DESCRIPTION .................................................................................................................................................... 4
2.2. CONSTRAINTS ................................................................................................................................................... 4
3. SOLUTION ARCHITECTURE ........................................................................................................................ 5
3.1. INTEGRATION LAYER:.......................................................................................................................................... 5
3.2. PRESENTATION LAYER: NONE ............................................................................................................................... 6
3.3. BUSINESS LAYER: NONE ...................................................................................................................................... 6
3.4. DATA LAYER: NONE............................................................................................................................................ 6
3.5. DATA STORAGE LAYER: NONE .............................................................................................................................. 6
3.6. SECURITY LAYER: REFERENCE SECURITY DOCUMENT.................................................................................................. 6
3.7. INFRASTRUCTURE LAYER: NONE............................................................................................................................ 6
3.8. COMMUNICATION PATTERN ................................................................................................................................ 6
4. SERVICE ENDPOINTS ................................................................................................................................ 8
4.1. RETRIEVE GOVERNMENT ENTITIES ........................................................................................................................ 8
4.1.1. Endpoint Description............................................................................................................................ 8
4.1.2. Request/Response format ................................................................................................................... 8
4.1.3. Response description ......................................................................................................................... 10
4.2. TRACKING ORDER ............................................................................................................................................ 11
4.2.1. Endpoint Description.......................................................................................................................... 11
4.2.2. Request/Response format ................................................................................................................. 11
4.2.3. Endpoint Description.......................................................................................................................... 13
4.3. POSTING TRANSACTION INFORMATION TO ISLAMIC BANK ....................................................................................... 14
4.3.1. Endpoint Description.......................................................................................................................... 14
4.3.2. Request/Response format ................................................................................................................. 14
4.3.3. Endpoint Description.......................................................................................................................... 16
5. SERVICE ERROR CODES ........................................................................................................................... 11
2
InfinitePL | Solution Low Level Design
3
InfinitePL | Solution Low Level Design
1. Overview
This is document for data exchanged from Integration platform to POS platform like Logistic,
Commercial or Government API. The document also contains the service error codes,
standardized for all services, and the technical error codes, which are also standardized.
The Implementation guide's objective is to provide external users and providers with
instructions for integrating Parcel Station services into various solutions using the Azure
function app.
2. Introduction
2.1. Description
The document consists of 2 main operations that are used for uploading order and tracking
order. In this document, we will introduce how our system integrates with these operations.
2.2. Constraints
Our system doesn’t apply any limits on the number of requests the client can make for
endpoint. But limitations may be applied in case of service misuse on the client side.
4
InfinitePL | Solution Low Level Design
3. Solution Architecture
3.1. Integration Layer:
Figure: POS integration
5
InfinitePL | Solution Low Level Design
3.2. Presentation layer: None
3.3. Business layer: None
3.4. Data layer: None
3.5. Data storage layer: None
3.6. Security layer: Reference security document
3.7. Infrastructure layer: None
3.8. Communication Pattern
6
InfinitePL | Solution Low Level Design
Figure: Request-and-Response pattern with Integration Platform
7
InfinitePL | Solution Low Level Design
4. Service endpoints
4.1. Retrieve Government Entities
API to get organization entity from Government API.
4.1.1. Endpoint Description
Endpoint URLs
Environment Base URL
Preproduction {{host}}/api/v1/interops/government/entiti
es
4.1.2. Request/Response format
Request Format
Response Schema
GET {{host}}/api/v1/interops/government/entities
Header Content Type application/json
Body key value
pageSize Page size parameter
pageIndex Page index parameter
Response Format
Response Schema
GET /api/v1/interops/government/entities
SUCCESS 200 {
"Results": [
{
"Organization": {
"Id": 4835,
"Name": ""لجنة المساهمات العقارية تصفية,
"SubName": ""االمين العام,
"IsMain": true
}
},
{
"Organization": {
"Id": 4836,
"Name": ""الجامعة السعودية اإللكترونية,
"SubName": ""رئيس الجامعة السعودية اإللكترونية,
"IsMain": true
8
InfinitePL | Solution Low Level Design
}
},
{
"Organization": {
"Id": 4838,
"Name": ""وزارة اإلسكان,
"SubName": ""وزارة اإلسكان,
"IsMain": true
}
},
{
"Organization": {
"Id": 4839,
"Name": ""الخطوط الجوية العربية السعودية,
"SubName": ""قسم االتصال المؤسسي,
"IsMain": true
}
},
{
"Organization": {
"Id": 4840,
"Name": ""بنك التنمية اإلجتماعية,
"SubName": ""الرئيس التنفيذي,
"IsMain": true
}
}
],
"StatusCode": 200,
"@[Link]":
"[Link]
iesResponse"
}
ERROR 404 {
"StatusCode": 404,
"Message": "error_not_found",
"Error": "Resource not found"
}
401 {
"StatusCode": 401,
"Message": "error_unauthorized",
"Error": "Access denied"
}
500 {
9
InfinitePL | Solution Low Level Design
"StatusCode": 500,
"Message": "error_internal_server"
"Error": "Internal Server Error"
}
4.1.3. Response description
Field Name Field Description
Type
@[Link] string Odata context url of OrderResponse object
StatusCode int System status code response
Results object Results response
Id int Entity organization ID
Name string Entity organization name
SubName string Entity Sub name
IsMain Boolean Main organization or not
Error
Field Name Field Type Description
StatusCode number Https status code of this request
Error string Message of this error.
Message string Message code from the system
10
InfinitePL | Solution Low Level Design
5. Service Error codes
Code HTTP Status Code Message Description
200 200 success_ok The request was successful and
returned data.
204 204 success_no_content The request was successful, but
no content was returned.
400 400 error_bad_request The client calls the endpoint with
invalid parameters
401 401 error_unauthorized Authentication is required or has
failed
404 404 error_not_found The client calls non-existed
endpoint
409 409 error_conflict A conflict occurred, such as a
duplicate resource
429 429 error_too_many_reques The client has sent too many
ts requests in each timeframe
500 500 error_internal_server An error occurs when processing
the user’s request
11