Skip to main content

FAQs

CMiC Authentication

To authenticate a CMiC user with CMiC using Agave Link, you will need the following information:

  • Server: this is retrieved from the URL of your CMiC instance. The value is everything up until after ".com". For example, with the URL https://testrti.cmiccloudr12.com/cmictestrti/, the value for "Server" is https://testrti.cmiccloudr12.com.
  • Client ID: this is the client registered in CMiC cloud. Note: a Client ID is not required for on-premise versions of CMiC.
  • Environment: this is the string of text after ".com" in the URL of your CMiC instance. For example, with the URL https://testrti.cmiccloudr12.com/cmictestrti/, the value for "Environment" is "cmictestrti".
  • Username: the username must be a registered user within CMiC.
  • Password: this is the password for the registered user within CMiC.

We recommend your customer contact their Customer Success Manager at CMiC to get a quote on enabling API access if they have not already.

CMiC On-premise Installations​

If your customer is using an on-premise CMiC instance, you will need to request that their IT team whitelist Agave's static IPs:

  • 13.58.14.240
  • 18.219.160.98
  • 3.143.37.24

This allows our servers to communicate with the CMiC database hosted on the customer's network.

note

If you run are unable to authenticate with Agave Link even after adding the above static IP addresses, we recommend following our guide on troubleshooting common issues with on-premise connections.

What CMiC API endpoints does Agave Sync use?​

ApplicationEndpointAPI DescriptionInsertUpdateDeleteQuery
AP-REST-APIapallvouchersAll Vouchers (Query only)NNNY
AP-REST-APIapvendorVendorsYYYY
AP-REST-APIapvoucherSC RFP Based VouchersYNNY
AP-REST-APIscrfpdetailSubcontract Request for Payment DetailsNNNY
AR-REST-APIarcustomerCustomersYYYY
AR-REST-APIarinvoiceInvoicesYYYY
CM-REST-APIcmdetailPCI DetailsYYYY
CM-REST-APIcmmastPCI MastersYYYY
CM-REST-APIcmstatusPCI Status CodeYYNY
CM-REST-APIcmownerchangeorderOwner Change OrdersYYNY
CM-REST-APIcmtypePCI TypesYYYY
GL-REST-APIglcompanyCompaniesNNNY
JC-REST-APIjcmastercategoriesMaster CategoriesNNNY
JC-REST-APIjcjobcostcodesJob Phases/Cost CodesNNNY
JC-REST-APIjcjobcategoryJob CategoriesYYYY
JC-REST-APIjcjobJobsYYNY
JC-REST-APIjcmastercostcodesMaster Phases/Cost CodesYYNY
PM-REST-APIpmprojcontactProject ContactsNNNY
PM-REST-APIpmprojectProjectsYYNY
PM-REST-APIpmprojpartnerProject PartnersYYNY
PM-REST-APIscmastSubcontract HeadersYYNY
PM-REST-APIscschedSubcontract DetailsYYNY
SYS-REST-APItermPayment TermsYYYY
SYS-REST-APIweightmeasureWeight MeasuresYYNY
SYS-REST-APIsdobjusrextvalueUser Extension FieldsYYNY