Skip to main content
Mitratech Success Center

04_Creating New API Calls

How to Create a New API Call

This will allow you to sync to a particular external module your company uses. CMO will then be able to take information from this third party and input it into forms and events (see the Adding API Calls to Your Forms help article). These are stored in the API Library, which is accessible in the Admin tab. 

 

Note: The API Response Calls License and API Library Module must both be enabled for this feature to be used.

  1. Login to CMO as power user
  2. Go to Admin -> API Library
  3. Click New button
    Adding API Calls.png
  4. Enter API Call details in opened pop-up
    1. Enter descriptive Name (e.g. "Example API #2")
    2. Enter API URL
      1. The URL should start with http:// or https://
      2. (e.g. https://api.example.com/employees)
    3. Choose API Response Format (JSON or XML are supported, see Mapping your API Response Format for more details)
      API Calls_Step 1.png
  5. Add HTTP Headers if needed (e.g. for authentication)
  6. Add Parameters if needed
    1. Click Add Parameter button
      API Calls_Step 2.png
    2. Enter parameter name (e.g. "login_name")
    3. Activate Mandatory check-box if the parameter has to be provided to API
    4. Configure default parameter mapping
    5. Click OK
      API Calls_Step 3.png
  7. Click Save
    API Calls_Step 5.png
  • Was this article helpful?