Best Practice | API Application Programs
  • 18 Oct 2024
  • 1 Minute to read
  • Dark
    Light

Best Practice | API Application Programs

  • Dark
    Light

Article summary

CMiC APIs are structured within API programs. Each API has a governing API program the determines which application the API rolls-up to.

API Programs are used as a structural frame across various functions:

  • API builds
  • API Security
  • API Licenses

For example, for Projects, the endpoint is PMproject and belongs to the API program pm-rest-api.

The following is a list of applications and their API Application Programs.

ProductContainer URL
GENERAL LEDGERgl-rest-api
ACCOUNTS PAYABLEap-rest-api
ACCOUNTS RECEIVABLEar-rest-api
JOB COSTjc-rest-api
JOB BILLINGjb-rest-api
EQUIPMENT MANAGEMENTem-rest-api
FIXED ASSETSfa-rest-api
INVENTORY MANAGEMENTci-rest-api
MATERIAL SALESms-rest-api
HUMAN CAPITAL MANAGEMENThcm-rest-api
CHANGE MANAGEMENTcm-rest-api
OPPORTUNITY MANAGEMENTom-rest-api
PROJECT MANAGEMENTpm-rest-api
PM DOCUMENTSpm-doc-rest-api
PURCHASE ORDERSpo-rest-api
PREVENTATIVE MAINTENANCEprm-rest-api
ENTERPRISE CONTENT MANAGEMENTecm-rest-api
DOCUSIGN ENVELOPES
SYSTEM DATAsys-rest-api