Skip to main content

Integration Points

Layman's summary

The Adi Jaya system does not stand alone. There is a connection to notifications, OTP email, PDF, Excel, and queue so that operational processes run smoothly.

Integration Overview

Integration Map

SPB/PO Notification Sequence

1) Firebase Cloud Messaging (FCM)

  • Model: FcmToken.
  • Endpoint membership stores tokens based on token_id.
  • Used in SPB/PO flow for push notifications.

2) Email / OTP

  • Event: OtpEvent
  • Listener: OtpListener
  • Mailer: OtpMail
  • Trigger of Membership\\OtpController@store.

3) PDF Generation

  • The SavePdfTrait trait is used by SPB/PO (and several other documents).
  • At certain state transitions, the document is regenerated (createOrUpdatePdf()).

4) Excel Export

  • Package maatwebsite/excel.
  • Export class is in app/Exports/Admin/* + related job.

5) Queue / Async

  • SPB/PO/payment export jobs.
  • Job push notification and process image files.
  • Configure queue in config/queue.php.

6) Basic Auth API Docs

  • Middleware/package tmd-bsa.
  • Docs endpoint: /api/v1/doc.

7) Maps API Key

  • Configure in config/maps-api-key.php (MAPS_API_KEY).

Integration Contract Table

IntegrationMain inputOutputsDomain owner
FCMdevice token + payloadpush notificationMembership + Core Flow
Mail OTPemail + OTPverification emailMembership
PDFdomain object (SPB/PO/SPK)PDF file storageProcurement/Project
Excelquery/list dataxlsx filesAdmin/Reporting
Queuesjob payloadasync processPlatforms
Requires verification
  • Firebase credential details (storage/app/firebase.json) must be ensured to be secure in production (encrypted/secret manager).
  • Active SMTP paths per env are not fully documented in the repo.