Elevate Your Egnyte Expertise. Join our Customer Community to connect with a network of peers and share game-changing strategies. Join Today

Welcome to
Help Desk

Product Updates
Training
Support
Ideas Community Contact Support

Apigee-based Developers Portal: Step-by-Step Guide

Egnyte has migrated its API management platform from Mashery to Apigee. This change is required to maintain a secure, scalable, and reliable environment for all the API integrations.

As part of this change, users will only be required to create a new account using the same email address they previously used on the Mashery-based Egnyte Developers Portal.

All existing API keys will continue to be available and visible in the Developers Portal, ensuring no disruption to current integrations. In addition, developers will have the option to create new applications and generate new keys as needed. They can also revoke an API key, or disable it; however, these are optional actions and not related to the migration.

The article covers the steps to create a new account, access existing keys, and create new apps to get new keys. You can register for a key† and explore and test the APIs first, or dive right into the documentation.

Egnyte Public API is not available for customers on Trial, Platform Team and Legacy Connect plans (Business, Office & Team). Use Current Plan to review the subscription and make plan changes.
- We can only approve API keys for domain Admins that are not using Service Accounts.
- It is recommended to use a Service Account with Egnyte APIs when authorizing Access Tokens. 
- For any questions or issues, please contact api-support@egnyte.com

†Refer to Usage Restrictions by Plan for API calls limits and restrictions. Contact your Sales Rep or Egnyte Sales team for details.

 

Skip Ahead To...

Create an Account 

Access Existing Keys

Get New Keys

Revoke an API Key

Disable an API 

Reset Password

 

Create an Account :

Creating an account is mandatory even if you previously had an account on the Mashery-based Egnyte Developers Portal.

  1. Navigate to the Developers Portal and click on Sign In.
    APIgee_create account and keys 1.png
  2. Click on Create an account.
    APIgee_create account and keys 2.png
  3. Enter the details, read through and agree to the terms, and click on Create Account.
    APIgee_create account and keys 3.png

    Users must provide the same email address previously used on the Mashery-based Developers Portal when creating their account.

  4. A new account will be created and an email will be sent for verification on the provided email address. 
  5. Users can click on the link in the email and verify their account. 

Back to Top...

 

Access Existing Keys

  1. Log in to the Developers Portal and click on the username on the top-right.
    APIgee_create account and keys 4.png
  2. Select Apps from the dropdown.
    APIgee_create account and keys 5.png
    The existing Apps will be displayed. Click on the app to view the associated API keys.
    APIgee_create account and keys 16.png

Back to Top...

 

Get New Keys

Egnyte admins can generate API credentials (Client ID and Client Secret) directly from the Egnyte Apps & Integrations store, without needing to register at developers.egnyte.com. Refer to How to Generate an Egnyte's API Key from the Apps & Integrations Store?

  1. Navigate to the Egnyte Apps & Integrations store in the admin console. Find the Create API Key tile at the bottom of the page. 
  2. Click the Create Keys button within the tile. 
  3. Select an Application Type.  If Public Application is selected, enter the Redirect URI in the field provided. 
  4. Click Generate API Key and it generates the API key automatically. The Client ID and Client Secret are displayed under App Credentials. 

    Integrations_Create API Tile_3.png
     
  5. Copy the credentials. The Client Secret can be revealed again later if needed. 

Back to Top...

 

Revoke an API Key

  1. Log in to the Developers Portal and click on the username on the top-right.
    APIgee_create account and keys 4.png
  2. Select Apps from the dropdown.
    APIgee_create account and keys 5.png
  3. Click on the App Name to view the details.
    APIgee_create account and keys 16.png
  4. Under API Keys, Click on Revoke under Actions.
    APIgee_create account and keys 17.png
  5. Click on Confirm to revoke the key. This action cannot be undone.
    APIgee_create account and keys 18.png
     

Back to Top...

 

Disable an API 

  1. Log in to the Developers Portal and click on the username on the top-right.
    APIgee_create account and keys 4.png
  2. Select Apps from the dropdown.
    APIgee_create account and keys 5.png
  3. Click on the App Name to view the details.
    APIgee_create account and keys 16.png
  4. Click on Disable for either of the APIs.
    APIgee_create account and keys 19.png
  5. Click on Save to save the changes. The app will then be updated. 
    APIgee_create account and keys 20.png
     

Password Reset

  1. Navigate to the Developers Portal and click on Sign In.
    APIgee_create account and keys 1.png
  2. Click on Reset password.
  3. Enter your email address and click Send Reset Password Link
  4. Check your email and click on the password reset link

Check your email address for instructions on resetting your password. If you do not see the email in your inbox, check your spam folder.

If you do not receive the email, please create a new account using the same email address previously used on the Mashery-based Egnyte Developers Portal.

 

Back to Top...

Was this article helpful?
1 out of 4 found this helpful

For technical assistance, please contact us.