Public API examples library

We have created a large collection of examples you can use to see all request details and real responses.

The examples are running in Postman and you will need to have Postman installed.

If you are not familiar with Postman:

Or if you prefer video:


Getting Started

  1. Get collection and environment
  2. Set active environment
    • It should be imported with 'Run in Postman' button Screenshot
    • Download from link above
    • Add new (tutorial here)
  3. To set default credentials run Set Environment at the bottom of the collection - it uses random strings for random folder paths Screenshot
  4. Go to some Basic Flow sections like Filesystem API - Basic Flow and try it step by step (use 'Reset Environment' for new random values)
  5. Read about API details on developers.egnyte.com

Custom credentials

  1. Go to Set Environment
  2. Choose Pre-request Script tab
  3. Change your credentials (to obtain authorization variable value read next section) Screenshot
  4. Send request!

Authentication

  1. Set your credentials in Set Environment request in Pre-request Script tab and send it (you don't need authorization value right now, leave it as it is)
  2. Click Authorization tab
  3. Choose OAuth 2.0 from the list Screenshot
  4. Click Get New Access Token button
  5. Copy the following without changing text to form in Postman
Name Value
Token Name {Choose name for your token}
Auth URL https://{{domain_name}}/puboauth/token?client_id={{client_id}}&redirect_uri=https://www.getpostman.com/oauth2/callback&response_type=code
Access Token URL https://{{domain_name}}/puboauth/token
Client ID {{client_id}}
Client Secret {{client_secret}}
Scope Egnyte.filesystem Egnyte.user Egnyte.group Egnyte.link Egnyte.permission Egnyte.bookmark Egnyte.launchwebsession
Grant Type Authorization code
Client Authentication Send client credentials in body

Now you can use the obtained token - check "Custom credentials" section above.

More details: developers.egnyte.com