cupa-konakart-xapi
home
Konakart Experience API
cupa-konakart-xapi is an experience API which exposes the product related data and marketing exhibition data to Konakart consumer fetched from various databases like Oracle Database, Pubsys via system and Process API.
Architecture Diagram:
Sequence Diagram:
Sequence Diagram Description:
No. | Steps | Description |
---|---|---|
1. | Request | Http Client invokes the mule services along with credentials (client id and client secret) in query params and X-TRANSACTION-ID (A code to track API calls end to end) via Mule Soft Secure API layer |
2. | Validate Credentials | Client id and Client secret credentials are validated by the security API mule gateway layer |
3. | If Validation fails, service returns specific fault response | If Validation fails, service returns specific fault response |
4. | Request | Request forward and behave like a passthrough API |
5. | Response | Response to Konakart |
6. | Return Response | Returns the success response. |
Endpoints:
1. To GET Product Details
GET: /product
This endpoint to post revision status, payload in below format.
[
{
"isbn13": "9781009101059",
"sapIdLevel3": "2800485457",
"digitalPhysical": "D",
"bibliographicTitle": "Get Psyched! Digital ITB (for Card)",
"productSizes": [
{
"type": "weight_kg",
"value": 1.23
}
],
"productBlurbs": [
{
"blurbType": "Blurb 15",
"blurbText": "A six-level English course that gets students speaking with confidence."
},
{
"blurbType": "Blurb 50",
"blurbText": "A six-level English course that gets students speaking with confidence..............."
},
{
"blurbType": "Blurb 150",
"blurbText": "A six-level English course that gets students speaking with confidence...................................."
}
],
"assets": [
{
"assetType": "Large Cover",
"assetUrl": "http://assets.cambridge.org/97810090/03452/large_cover/9781009003452i.jpg"
},
{
"assetType": "Thumbnail",
"assetUrl": "http://assets.cambridge.org/97810090/03452/large_cover/9781009003452i.jpg"
}
],
"pricesCurrent": [
{
"salesOrg": "1201",
"distrChannel": "00",
"priceType": "01",
"priceTypeQual": "05",
"priceStatus": "02",
"currency": "GBP",
"price": 100.22
},
{
"salesOrg": "1201",
"distrChannel": "00",
"priceType": "01",
"priceTypeQual": "05",
"priceStatus": "02",
"currency": "EUR",
"price": 110.22
}
],
"taxClassId": "Taxable Goods",
"model": "Purchase",
"canOrderWhenNotInStock": "Yes",
"manufacturerId": "Cambridge University Press",
"exclusions": "zh_CN,es_CU,fa_IR,ko_KP,ar_SD,ar_SY,es_VE",
"globalPublicationDate" : "2016-03-11T03:38:14.000Z",
"englishShopSetting":
{
"deliveryPlatformButtonMessageText" : "Go to cambridge one",
"deliveryPlatformButtonURL" : "https://www.cambridge.org",
"maxBasketQuantity" : "10",
"ticketQuantity" : "10",
"orderConfirmationMessage" : "You will shortly receive and email"
}
}
]
Topic | Details | |
---|---|---|
1. | Operation Description | To get product details |
2. | URI | /product |
3. | Method | GET |
6. | Synchronous/ Asynchronous | Synchronous |
7. | Protocol | HTTPS |
8. | URL | https://apis.cambridgeassessment.org.uk/cupa-konakart-xapi/api/product/ |
9. | Mode of Communication | ☐ Batch ☐ Message ☒ Real Time |
10. | Interface Pattern | ☐ Publish / Subscribe ☒ Request / Reply |
2. To GET Marketing Exhibitions Details
GET: /marketing/exhibitions:
This endpoint is used to get Marketing Exhibitions Details , payload in below format.
[
{
"exhibitionId": "82466",
"exhibitionName": "British Society for Allergy & Clinical Immunology Annual Meeting",
"exhibitionStatus": "Attend through agent firm",
"exhibitionStartDate": "2015-01-01",
"exhibitionFinishDate": "2016-03-11",
"exhibitionSubjectCode": "22",
"exhibitionSubject": "Biomedical Sciences",
"exhibitionUrl": "",
"exhibitionPriceDiscountPerc": 10,
"exhibitionPriceDiscountStartDate": "2015-01-01",
"exhibitionPriceDiscountEndDate": "2016-01-01",
"venueCountry": "England",
"venueTown": "Loughborough",
"updatedAt": "2016-03-11T03:38:14.000Z",
"deletedAt": "2016-03-11T03:38:14.000Z",
"products": {
"books":[
"9780521009393",
"9780521525800",
"9780521540278",
"9780521570756",
"9780521644815",
"9780521655781",
"9780521796538"
],
"journals": [
"HYG",
"PAR"
]
}
},
{
"exhibitionId": "96557",
"exhibitionName": "Climate Justice and Disaster Law Book Launch",
"exhibitionStatus": "Firm attended",
"exhibitionStartDate": "2016-06-09",
"exhibitionFinishDate": "2016-06-09",
"exhibitionSubjectCode": "22",
"exhibitionSubject": "Biomedical Sciences",
"exhibitionUrl": "",
"exhibitionPriceDiscountPerc": 20,
"exhibitionPriceDiscountStartDate": "2015-01-01",
"exhibitionPriceDiscountEndDate": "2016-01-01",
"venueCountry": "England",
"venueTown": "Cambridge",
"updatedAt": "2016-03-11T03:38:14.000Z",
"deletedAt": "2016-03-11T03:38:14.000Z",
"products": {
"books":[
"9781107107229"
],
"journals": []
}
}
]
Topic | Details | |
---|---|---|
1. | Operation Description | To get marketing exhibitions details |
2. | URI | /marketing/exhibitions |
3. | Method | GET |
6. | Synchronous/ Asynchronous | Synchronous |
7. | Protocol | HTTPS |
8. | URL | https://apis.cambridgeassessment.org.uk/cupa-konakart-xapi/api/marketing/exhibitions |
9. | Mode of Communication | ☐ Batch ☐ Message ☒ Real Time |
10. | Interface Pattern | ☐ Publish / Subscribe ☒ Request / Reply |