Start Sessions with Session Key Acceptance

An alternative method of starting a session is to create a web form where your customers can enter short session key strings to start sessions with you.

To create a session key entry form, create a web form with the action of https://support.example.com/api/start_session and a method of either GET or POST. You must also use a text box with the name of short_key, as shown in the example below.

<form action="https://support.example.com/api/start_session" method="get">

Session Key: <input type="text" name="short_key" /><br />

<input type="submit" value="Submit" />

</form>

 

You may also include an external key to start a session.

<form action="https://support.example.com/api/start_session" method="get">

Session Key: <input type="text" name="short_key" /><br />

External Key: <input type="text" name="session.custom.external_key" /><br />

<input type="submit" value="Submit" />

</form>

 

Using this form, your customer can enter a generated seven-character session key and an optional external key to start a session with you.

Note: The external_key parameter has been deprecated as of 14.2 and has been replaced with session.custom.external_key. However it is still available for backward compatibility.