Embedded UI API

The Navigate API (formerly the Embedded UI API) allows you to start an Egnyte Web UI session in the web browser with a public API token. To use this API your authentication token must have been requested with the Egnyte.launchwebsession scope.

Navigate API (V2)

This endpoint is used to allow users to access files and folders from within other browser pages besides the Egnyte Web UI. The endpoint can return either a link to the full Egnyte Web UI, or an embedded view.

For more information about impersonation, please, refer to the Best Practices.

POST/pubapi/v2/navigate

Request Parameters

Parameter	Description	Required	Possible Values
embedded	When true, the returned URL will load an embedded view of the Web UI that does not include the header, search, folder tree, or activity stream. When false, the returned URL will load the full Egnyte Web UI.	Yes	true, false
path	The path to the folder you would like to have opened. When ommitted, this will default to the user's home folder.	No	Full file path, e.g. /Shared/test

Request Examples

HTTP

POST /pubapi/v2/navigate HTTP/1.1
          Host: apidemo.egnyte.com
          Authorization: Bearer 68zc95e3xv954u6k3hbnma3q
          Content-Type: application/json
          {
            "embedded": true,
            "path": "/Shared/Projects/Project Alpha"
          }

Expected Response

  {
    "redirect": "https://apidemo.egnyte.com/navigate/temp/2c7e1b8b-d6bf-46f3-b8f1-96a937555099"
  }

Loading the Web UI in the User's Browser

The redirect URL from the response can then be loaded in the user's browser. Note that this URL is a one-time URL. If accessed a second time it will return a 404 error.

Version 1 (Deprecated)

This endpoint is used to allow users to access files and folders from within other browser pages besides the Egnyte Web UI.

POST/pubapi/v1/navigate/embedded/{scope}

Request Parameters

Parameter	Description	Required	Possible Values
scope	State the scope of the resources that you want to utilize.	Yes	home, folder/.*

Method-specific Response Codes

Error Code	Error Message	HTTP Code	Troubleshooting
Unauthorized	This request is unauthenticated. Please provide credentials and try again.	401	Check that your token has Egnyte.launch websession scope.

POST /pubapi/v1/navigate/embedded/folder/Shared/test HTTP/1.1
          Host: apidemo.egnyte.com
          Authorization: Bearer 68zc95e3xv954u6k3hbnma3q

curl -v -X POST -H "Authorization: Bearer 68zc95e3xv954u6k3hbnma3q" https://apidemo.egnyte.com/pubapi/v1/navigate/embedded/folder/Shared/test

Expected Response

The response is a HTTP 303 Code that redirects the user to a temporary link. The temporary link includes a one-time token. Loading the link in a browser will initialize a regular web session without requiring the user to log into the web interface.

HTTP/1.1 303 See Other
    Location: https://apidemo.egnyte.com/navigate/temp/15f221dc-5405-4988-9f47-f480dbb0b285
    Content-Type: application/vnd.egnyte.error+json;v=1;charset=UTF-8

TIP: Handling the response
Unlike other Egnyte APIs, this API does not return data as a JSON object. The response to a successful call uses an HTTP 303 response. The URL that can be used to open the embedded UI is returned in the "Location" response header. When calling this API, be sure to configure your HTTP client to not follow redirects. If a redirect is followed it will return the actual HTML content of the embedded UI. This API cannot be used directly in the browser with JavaScript because web browsers automatically follow redirects. You need to call this API with server-side code.

TIP: Handling the response

Unlike other Egnyte APIs, this API does not return data as a JSON object. The response to a successful call uses an HTTP 303 response. The URL that can be used to open the embedded UI is returned in the "Location" response header. When calling this API, be sure to configure your HTTP client to not follow redirects. If a redirect is followed it will return the actual HTML content of the embedded UI.

This API cannot be used directly in the browser with JavaScript because web browsers automatically follow redirects. You need to call this API with server-side code.

User Redirected to Egnyte Session

When the user navigates to the temporary url that was generated in the previous step, he gets redirected to the active Egnyte session at the specified path. If the folder path provided is invalid, the user will see an error message in the UI.

version 14 as of 3 years ago by Vitaly Obernikhin

Previous: Metadata API
Up: Overview
Next: Bookmarks API

Embedded UI API

Navigate API (V2)

Request Parameters

Request Examples

Expected Response

Loading the Web UI in the User's Browser

Version 1 (Deprecated)

Request Parameters

Method-specific Response Codes

Request Examples

Expected Response

User Redirected to Egnyte Session

Docs Navigation