Best Practice | API Application Programs

Prev Next

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.

Product Container URL
GENERAL LEDGER gl-rest-api
ACCOUNTS PAYABLE ap-rest-api
ACCOUNTS RECEIVABLE ar-rest-api
JOB COST jc-rest-api
JOB BILLING jb-rest-api
EQUIPMENT MANAGEMENT em-rest-api
FIXED ASSETS fa-rest-api
INVENTORY MANAGEMENT ci-rest-api
MATERIAL SALES ms-rest-api
HUMAN CAPITAL MANAGEMENT hcm-rest-api
SUBCONTRACT PREQUAL prq-rest-api
CHANGE MANAGEMENT cm-rest-api
OPPORTUNITY MANAGEMENT om-rest-api
PROJECT MANAGEMENT pm-rest-api
PM DOCUMENTS pm-doc-rest-api
PURCHASE ORDERS po-rest-api
PREVENTATIVE MAINTENANCE prm-rest-api
ENTERPRISE CONTENT MANAGEMENT ecm-rest-api
SYSTEM DATA sys-rest-api