# Template browser

Hosted UI for end users to select the appropriate template. Use this if you want to take advantage of our UI.

## Create a new browser session

 - [POST /api/browser/sessions](https://developers.docue.com/embeddable-builder-api/openapi/template-browser/createbrowsersession.md): To use our template browser for selecting the correct template, create a new browser session and redirect the end user to our app. Our app will then redirect the user back to your app to the URL defined in the handlers.

By creating a new browser session, you receive a redirect URL to send the end user. You also obtain a browser session ID, which allows you to retrieve the selected template, language, and the document title provided by the end user.

The redirect URL is a secure link to our hosted app. It contains a one-time authorization token to authenticate the end user securely. Our app exchanges the token for a session cookie, granting access to this specific browser session only.

The session expires after 15 minutes if the user has not been redirected to the URL.

#### Handlers

When creating a browser session, you must provide handler URLs.

Success handler
The user is redirected to this URL after successfully selecting the template and other details. Please note that the user may be redirected to this URL multiple times if they navigate back to the session using the browser's history.

Cancel handler
The user is redirected to this URL when they intentionally cancel the template selection by clicking the "back button" in the header. They can continue using the template browser if they navigate back to the session using the browser's history; therefore, this may be called multiple times.

Delete handler
The user is redirected to this URL when the browser session expires or is deleted via the API. In many cases, it is acceptable to use the same endpoint as in the cancel handler. This may be called multiple times.

Error handler
The user is redirected to this URL when something unexpected occurs.

#### Handler url parameters

The handler URL is appended (existing query parameters will remain intact) with the following query parameters:
| Parameter       | Description                                                    |
| --------------- | -------------------------------------------------------------- |
| session_id    | Template browser session ID                                   |
| template_id   | ID of the selected template (only on success)                  |
| document_name | Name the end-user choosed for the document (only on success)   |
| languages[0]  | Primary language of the document    (only on success)          |
| languages[1]  | Secondary language of the document (only on success, optional) |


For example, if you have defined success handler:
json
"success_handler": {
  "endpoint": "https://example.com?handler=success",
  "method": "GET"
}

The user will be redirected to URL:
  
  https://example.com?handler=success&session_id=0195c6eb-99ae-73c1-94f0-1763b872735d&template_id=0195c6eb-99ae-73c1-cc3a-1763b8743333d&language[0]=en-GB&document_name=Employment%20Agreement
  

In most cases, you want to immediately start a new builder session using the provided data and redirect the user back to our UI.

## Retrieve details of existing browser session

 - [GET /api/browser/sessions/{session_id}](https://developers.docue.com/embeddable-builder-api/openapi/template-browser/getbrowsersession.md): Returns details of the existing browser session. This information can serve as the source of truth when the user is redirected to your success handler.

## Delete browser session

 - [DELETE /api/browser/sessions/{session_id}](https://developers.docue.com/embeddable-builder-api/openapi/template-browser/deletebrowsersession.md): Invalidates the browser session. The session remains accessible through the API for a limited time before it is permanently deleted. If the end user is still viewing the page, they will be redirected to the delete handler URL you specified.

> There is no need to delete completed sessions; they will be automatically pruned after a certain period.