LogOn (obsolete)
OBSOLETE. Use LogOn v2.
Description
Create a new session. This is how you "log on" to the GCAPI.
Service Info
target | session |
uriTemplate | / |
transport | POST |
envelope | JSON |
contentType | application/json |
Parameters
Name | Type | Description |
---|---|---|
apiLogOnRequest | ApiLogOnRequestDTO |
The request to create a session (log on). |
Return Value
ApiLogOnResponseDTO (deprecated)
Example
The following request to the Live GCAPI environment logs in to your account using the example credentials of Username as "DM123456" and password as "openthedoor".
The AppKey required to use the GCAPI is sent to you once you have returned the signed terms and conditions of the GCAPI to our Partnerships team:
(PartnershipServices[at]cityindex.com).
POST https://ciapi.cityindex.com/TradingAPI/session
Post Request Body
{"Password":"openthedoor",
"UserName":"DM123456",
"AppKey":"ABC"
}
A successful request results in an HTTP 200 code in the response header, and the response body is the ApiLogOnResponseDTO (deprecated) in JSON format.
Last updated: 18 April 2023
Copyright © 2024 GAIN Capital