developers:login [WIKI]

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Logging in to the T4 API ======

====== Sim Login API ======

^ Method   | POST                                |
^ URL      | https://api-sim.t4login.com/login   |
^ Body     |                                     |

<code>
{
    "firm" : "<Firm Name (CTS)>",
    "userName" : "<Username>",
    "password" : "<Password>",
    "appName" : "<Application Name>",
    "appLicense" : "<Application License>"
}
</code>

==== Example Response ====

<code>
{
    "token": "<Authentication Token>",
    "expires": <Expire Time>
}
</code>

**token**: This is the authentication token that your application must use for subsequent API requests. Include this token in the Authorization header as a Bearer token for each request. The format for the Authorization header should be `Authorization: Bearer <Authentication Token>`.

**expires**: This is the expiration time of the token, provided as a Unix timestamp. It indicates the time until which the token is valid. You should handle token expiration in your application and implement a mechanism to refresh the token as necessary, typically by making another login request upon token expiry.

====== Live Login API ======
<WRAP center round info 100%>
All live logins are assigned to you by your clearing firm admin, not CTS
</WRAP>

^ Method   | POST                                |
^ URL      | https://api.t4login.com/login   |
^ Body     |                                     |

<code>
{
    "firm" : "<Assigned by your clearing firm>",
    "userName" : "<Username>",
    "password" : "<Password>",
    "appName" : "<Application Name>",
    "appLicense" : "<Application License>"
}
</code>
==== Example Response ====

<code>
{
    "token": "<Authentication Token>",
    "expires": <Expire Time>
}
</code>

**token**: This is the authentication token that your application must use for subsequent API requests. Include this token in the Authorization header as a Bearer token for each request. The format for the Authorization header should be `Authorization: Bearer <Authentication Token>`.

**expires**: This is the expiration time of the token, provided as a Unix timestamp. It indicates the time until which the token is valid. You should handle token expiration in your application and implement a mechanism to refresh the token as necessary, typically by making another login request upon token expiry.