MangoApps Open APIs

Overview

The Registered Application and Register a New Application tabs in the APIs & Webhooks menu under the Integrations section of the Admin Portal allow domain administrators to manage and register applications that interact with MangoApps via Open APIs.

Click here to browse MangoApps Open API documents. This documentation provides a comprehensive list of available APIs you can use to build integrations. Once you're familiar with the APIs, you can follow the instructions below to register your application and obtain the necessary credentials.

---

Registered Applications

From the Admin Portal, navigate to Integrations > APIs & Webhooks. Select the Registered Applications tab.

This page will display a list of all currently registered applications in your domain. Each registered application will have details such as the application name, support contact information, and permissions.

---

Registering a New Application

To register a new application that will interact with your MangoApps domain click on the Register a New Application tab.

Complete the registration form:

• Application Name: Enter a unique name for the application within your domain.

• Developer/Organization Name: Enter your name or the name of the organization responsible for maintaining the application.

• Support Email: Provide an email address where support queries related to this application will be directed.

• Support URL: Provide a URL where users can access support documentation or FAQs for the application.

• API Access Level:

  • Read Only: The application can only retrieve data (GET requests).

  • Read and Write: The application can create, update, and delete data (GET, POST, PUT, DELETE requests).

Review and agree to the Terms and Conditions.

Click Submit Registration to finalize the application registration.

Once registered, the application will appear in the list of registered applications.

---

MangoApps OpenAPI Usage Basics

When integrating with MangoApps using the OpenAPI set, adhere to the following guidelines:

• Authentication Session:

  • Upon successful login via the Login API, you will receive a _felix_session_id in the Set-Cookie field of the response header.

  • Your application must store this _felix_session_id securely for use in subsequent API requests.

  • All subsequent API requests must include the _felix_session_id as a cookie in the header.

  • The session remains valid until explicitly terminated by calling the Logout API.

• Using cURL Examples:

  • In cURL examples, a file is often used to store the _felix_session_id. You can define this file name as needed during your testing.

• API URLs:

  • Always use your own MangoApps domain URI followed by the appropriate API path and parameters.

  • Do not use mangoapis.mangoapps.com as shown in examples; replace this with your domain-specific URI.

By following these steps and guidelines, administrators can successfully register, manage, and utilize custom applications integrated with their MangoApps domain.