Managing API Applications

Document created by user.oxriBaJeN4 Employee on Aug 3, 2018Last modified by user.oxriBaJeN4 Employee on Aug 6, 2018
Version 5Show Document
  • View in full screen mode

This guide describes how you can add, change, enable / disable, and delete API applications in the Administration Console.

 

Applies To...

 

  • Administrators responsible for adding and managing the API applications your organization has developed.

 

Add APIAccessing Your API Applications


To access your API Applications:

  1. Log on to the Administration Console.
  2. Click on the Administration toolbar button. A drop down menu is displayed.
  3. Click on the Services | API Applications menu item. Any existing API applications are displayed. 

 

With your API applications displayed you can:

  • Add an application
  • Edit an application
  • Delete an application

 

Adding an API Application

 

To add a new API Application:

  1. Click on the Add API Application button.
  2. Fill in the Details section as outlined below:
    FieldDescription
    Application NameProvide a name for the application that you can easily identify.
    CategorySelect a category for the application from the drop down menu:
    • SIEM Integration: Relates to security information and event management (SIEM), that provides real-time analysis of security alerts generated by the application.
    • MSP Ordering & Provisioning: Assists with provisions for the Managed Service Provider (MSP) Portal, available for select Partners to manage customers.
    • Email / Archiving: The application relates to the messages and files stored in Mimecast.
    • Business Intelligence: The application's infrastructure and tools enable access to and analysis of information to improve and optimize decisions and performance.
    • Process Automation: The application allows automation of business processes. 
    • Other: Select this option if the application doesn't fit with any of the other categories.
    DescriptionProvide a description of the application.
  3. Click on the Next button
  4. Fill in the Settings section as outlined below: 
    FieldDescription
    DeveloperAdd the name of the application's developer.
    EmailAdd the email address of the application's developer.
  5. Click on the Next button.
  6. Review the information displayed in the Summary page to ensure all details are correct. To fix any errors:
    • Click on the Edit link next to the Details or Settings to return to the relevant page.
    • Make your changes and click on the Next button to proceed to the Summary page again.
      API application Edit links
  7. When you're ready, click on the Add button. The application's details display in a slide in panel, along with the following features: 
    FeatureDescription
    Application IDThe unique identification number assigned to your application. To use the ID number:
    1. Click on the Page Icon icon. The ID is copied to your clipboard.
    Application KeyThe unique identifier for the application's authentication. It's hidden by default. To use the key:
    1. Click on the Eye Icon icon. The key displays.
    2. Click on the Page Icon icon. The key is copied to your clipboard.
    EditClick on the Edit button to correct any errors in the application information. See the "Editing an API Application" section below for more detail.
    DeleteClick on the Delete button to remove the application. See the "Deleting an API Application" section below for more detail.
    EnabledThe application is active by default. Optionally toggle off the Enabled setting to deactivate.
  8. Click on the X to exit the panel. The application displays.

Editing an API Application

Editing an App

To edit an API Application:

  1. Click on the application you wish to edit. A slide in panel displays.
  2. Click on the Edit button. The Details settings tab displays by default. 
  3. Make any necessary changes. You can click on Settings / Details in the left hand navigation panel to switch between tabs as required.
  4. Click on the Save & Close button. Your changes are applied to the application information displayed.
    Changing settings won't generate a new application key.

Enabling / Disabling an API Application

 

To enable / disable an API Application:

  1. Click on the application you want to enable / disable. A slide in panel displays.
  2. Toggle the Enabled setting on / off.

Enable APIAlternatively:

  1. Click on the three-dot menu icon in the far right corner of the listed applications. A drop down menu displays.
  2. Click on Enable / Disable from the menu, depending on the application's current setting.
  3. A popup message displays to confirm your selection.

Deleting an API Application


To delete an API Application:

  1. Click on the application you want to delete. A slide in panel displays.
  2. Click on the Delete button. A popup box displays to confirm the request.
  3. Click on the Delete button to proceed. The application is removed.

 

Delete APIAlternatively:

  1. Click on the three-dot menu icon in the far right corner of the listed application. A drop down menu displays.
  2. Click on DeleteThe application is removed.

Attachments

    Outcomes