Core Identity PAPI
home
Core Identity Process API
This API retrieves and process the Person Account and preference data for an Identity ID from Cambridge Core eTOC and feed it to Marketing Preference PAPI and there by feed eTOC data to Salesforce. It uses Core Identity SAPI to fetch identity details.
The identity ID gets fetched from Amazon SQS queue owned by Cambridge Core.
Input Identity ID:
Identity ID send by Source System - Cambridge Core eTOC via Amazon SQS.
Example identity ID:
{"identityId":"8a97022b6a52a637016b794db15227ae"}
Architecture Diagram:
Source System
- eTOC Cambridge Core
Dependency APIs
Integration
Endpoints:
Get status if Application
- GET: /status
To check the health of the API
This endpoint displays the status of the application in JSON format.
| Topic | Details | |
|---|---|---|
| 1. | Operation Description | Check the current status of API |
| 2. | URI | /api/status |
| 3. | Method | GET |
| 4. | Response | { "application": "cupa-core-identity-papai-dev", "version": "v1", "environment": "dev", "status": "Running", "timestamp": "2023-02-02T07:41:43.227Z+00:00" } |
| 5. | Synchronous/Asynchronous | Synchronous |
| 6. | Protocol | HTTPs |
| 7. | URL | https://apis-sandbox.cambridgeassessment.org.uk/cupa-marketing-preference-xapi-dev/api/status |
| 8. | Mode of Communication | ☐ Batch ☐ Message ☒ Real Time |
| 9. | Interface Pattern | ☐ Publish / Subscribe ☒ Request / Reply |