Skip to content

OAuth Integration Quickstart

Introduction

This guide aims to help enterprise developers understand how to integrate the Teachify platform with your OAuth provider system. This integration not only enhances security and data privacy but also provides a seamless user experience allowing users to access Teachify’s services using existing enterprise credentials.

Benefits

  1. Enhanced Security: Leverages existing authentication mechanisms to reduce potential security risks.
  2. Increased Efficiency: Users can log in using their company credentials without needing to create new accounts, simplifying the login process.
  3. Unified User Experience: The integrated system offers a consistent user interface, improving user satisfaction.

Implementation Steps

OAuth Flow

To ensure a successful integration of Teachify with your OAuth system, it is imperative that the following API endpoints and steps are fully implemented:

  1. Authorization Endpoint: This endpoint is crucial for the authorization and authentication of users. It initiates the OAuth flow by redirecting users for login and consent, thereby granting Teachify the necessary permissions to access user data under defined scopes.

  2. Token Endpoint: After the authorization is complete, your system should redirect the user back to the specified redirect_uri with an authorization code. Teachify will then use this code to request an access token from your token endpoint.

    For an example of how to exchange the authorization code for an access token, see our Token Exchange Example.

  3. User Information Endpoint: This endpoint is essential for retrieving basic information about the user once they have been authenticated. Teachify utilizes this data to personalize and enhance the user experience on our platform.

    For an example of how to retrieve user information using the access token, see our User Information Retrieval Example.

IP Allowlisting

To enhance security, we recommend setting up IP allowlisting for your OAuth integration. This ensures that only requests from trusted IP addresses are accepted.

Teachify’s IP Address

Please add the following IP address to your allowlist:

43.207.76.33

Please carefully assess your system’s capability to support these endpoints and steps. If there are any uncertainties regarding the specifications or implementation details, do not hesitate to reach out to Teachify for further clarification or assistance. We are here to support you through every step of the integration process to ensure a seamless and efficient setup.