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, legacy Office and Team plans.
- 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 

 

Create an Account 

  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

  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 New App.
    APIgee_create account and keys 6.png
  4. Provide the app details:
    • Enter the required App Name and detailed Description.
      Note: App requests with insufficient description will be not be approved.
      APIgee_create account and keys 7.png
    • Provide additional details as Egnyte domain (required), App Icon URL(Optional), Registered OAuth Redirect URI (If needed).
      APIgee_create account and keys 8.png
    • Select Type as Publicly Available Application (default) or Internal Application (own company use only)
      APIgee_create account and keys 9.png
    • Select the User Base
      APIgee_create account and keys 10.png
    • Choose the Platform from the available options. Web App is selected by default. 
      APIgee_create account and keys 11.png
  5. Click on Request for Collaborate and/or Secure & Govern (SnG-API) to request for the key.
    APIgee_create account and keys 12.png 
    • The user must request for at least one API key for the app
    • If both Collaborate and SnG-API are selected, one API key will be generated that can be used on both applications
    • Only one API key can be requested from the Developers Portal for each application. To request for additional API keys for the same app, contact the API Support team
  6. Click on Save after entering all the details.
    APIgee_create account and keys 13.png

The API Support team will be notified and the user will be able to view the API keys. The status will remain inactive until the request is approved. The approval process can take up to 24 hours. 

APIgee_create account and keys 14.png

The status will change to Active once the request is approved. 

APIgee_create account and keys 15.png

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

Back to Top...

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

For technical assistance, please contact us.