การตรวจสอบสิทธิ์แอปและบัญชี¶

กระบวนการตรวจสอบสิทธิ์ของ cTrader Open API ใช้มาตรฐาน OAuth 2.0

เฟรมเวิร์กนี้ช่วยให้แอปพลิเคชันของบุคคลที่สามสามารถเข้าถึงบริการได้อย่างจำกัด โดยการประสานงานระหว่างเจ้าของทรัพยากรและบริการ หรือโดยอนุญาตให้แอปพลิเคชันของบุคคลที่สามเข้าถึงได้ด้วยตนเอง

ขั้นตอนการตรวจสอบสิทธิ์ ¶

ตามมาตรฐาน OAuth 2.0 การตรวจสอบสิทธิ์บัญชีต้องใช้ทั้งรหัสอนุญาตและโทเค็นการเข้าถึง

โดยทั่วไป กระบวนการที่ผู้ใช้ใหม่เริ่มใช้แอปพลิเคชันของคุณเป็นครั้งแรกมีลักษณะดังนี้:

1. ผู้ใช้ที่มี cTID หนึ่งเข้าถึงแอปพลิเคชันของคุณไม่ว่าจะถูกใช้งานที่ใด ผู้ใช้จะโต้ตอบกับปุ่มดำเนินการหรือสิ่งที่เทียบเท่า

2. แอปพลิเคชันใช้เบราว์เซอร์ที่ฝังไว้ (หรือวิธีการอื่นที่เหมาะสม) เพื่อเปลี่ยนเส้นทางผู้ใช้ไปยัง URI เฉพาะที่พวกเขาจะให้สิทธิ์ที่จำเป็นแก่แอป

3. ผู้ใช้จะถูกเปลี่ยนเส้นทางไปยัง URL ที่กำหนดไว้ล่วงหน้า URL นี้มีโทเค็นการเข้าถึงเป็นค่าของพารามิเตอร์ code

4. ผู้ใช้จะถูกเปลี่ยนเส้นทางกลับไปยังแอปพลิเคชันด้วยตนเองหรือโดยอัตโนมัติ แอปพลิเคชันจะได้รับทราบค่าของพารามิเตอร์ code

5. แอปพลิเคชันส่งคำขอเพื่อแลกเปลี่ยนรหัสอนุญาตกับโทเค็นการเข้าถึงไปยัง endpoint เฉพาะ

6. แอปพลิเคชันได้รับคำตอบที่มีโทเค็นการเข้าถึงเป็นค่าของคีย์ accessToken

7. แอปพลิเคชันส่งข้อความ ProtoOAApplicationAuthReq ที่มีฟิลด์ clientId และ clientSecret

8. แอปพลิเคชันส่งข้อความ ProtoOAGetAccountListByAccessTokenReq ที่มีฟิลด์ accessToken คำตอบ (ProtoOAGetAccountListByAccessTokenRes) มีฟิลด์ ctidTraderAccountId ที่ซ้ำกัน

9. หลังจากได้รับคำตอบ แอปพลิเคชันส่งข้อความ ProtoOAAccountAuthReq ที่มีฟิลด์ ctidTraderAccountId และ accessToken

หลังจากนั้น ผู้ใช้ควรได้รับการตรวจสอบสิทธิ์ภายใต้บัญชีที่ ctidTraderAccountId ตรงกับ ctidTraderAccountId ที่ให้ไว้ในขั้นตอนที่ 8

แผนภาพด้านล่างอธิบายว่าขั้นตอนพื้นฐานของการตรวจสอบสิทธิ์ทำงานอย่างไรจากมุมมองของแอปพลิเคชัน Open API ของคุณ

graph TB
  A([เปลี่ยนเส้นทางผู้ใช้ไปยัง <br/> URI เฉพาะ]) ==> B([รับรหัสการอนุญาต <br/> ]);
  B ==> C([ส่งคำขอเพื่อรับ <br/> รหัสการเข้าถึง]);
  C ==> D([ส่ง ข้อความ <br/> ProOAApplicationAuthReq <br/> ]);
  D ==> E([ส่ง ข้อความ <br/> ProtoOAAccountAuthReq <br/> ]);

ในส่วนย่อยด้านล่าง เราจะอธิบายขั้นตอนสำคัญของกระบวนการตรวจสอบสิทธิ์อย่างละเอียด

เพิ่ม URI ที่เปลี่ยนเส้นทาง ¶

ดังที่แสดงไว้ก่อนหน้านี้ แอปพลิเคชันของคุณต้องได้รับรหัสอนุญาตหลังจากผู้ใช้ถูกส่งไปยัง URI ที่เปลี่ยนเส้นทางเฉพาะ URI นี้จะรวมรหัสอนุญาตเป็นค่าของพารามิเตอร์ code

เพื่อเพิ่ม URI ที่เปลี่ยนเส้นทางใหม่ ให้ทำดังนี้:

1. เปิดหน้า Applications ในพอร์ทัล Open API

2. เลือกปุ่ม Edit ในแถวที่มีแอปพลิเคชันที่คุณต้องการเพิ่ม URL ที่เปลี่ยนเส้นทาง

3. ในหน้าจอที่ปรากฏขึ้นใหม่ เลื่อนลงไปที่ส่วน Redirect URIs

4. เพิ่ม URL ที่เปลี่ยนเส้นทางในช่องข้อความว่างที่พร้อมใช้งาน หากไม่มีช่องว่างแสดงขึ้น ให้เลือกปุ่ม Add redirect URI

5. เลือกปุ่ม Save ที่ด้านล่างของหน้าเพื่อบันทึกการเปลี่ยนแปลงของคุณ

รับรหัสอนุญาต ¶

เพื่อรับรหัสอนุญาตสำหรับ cTID เฉพาะ แอปพลิเคชันของคุณจะต้องส่งผู้ใช้ไปยัง URI ต่อไปนี้

https://id.ctrader.com/my/settings/openapi/grantingaccess/?client_id={clientId}&redirect_uri={your_redirectURI}&scope={scope}&product=web

URI นี้มีพารามิเตอร์คำถามต่อไปนี้

เพื่อดู client_id ของคุณ ไปที่หน้า Applications และเลือกปุ่ม View ในคอลัมน์ Credentials

หลังจากผู้ใช้ถูกส่งไปยัง URI ด้านบน (และตราบใดที่ทั้งสองพารามิเตอร์ถูกต้อง) พวกเขาควรเห็นหน้าจอเข้าสู่ระบบ/สมัครสมาชิกที่ขอให้พวกเขาอนุญาตภายใต้ cTID ของพวกเขา หลังจากนั้น ผู้ใช้จะเห็นกล่องโต้ตอบที่พวกเขาจะสามารถอนุญาตให้แอปพลิเคชันเข้าถึงบัญชีหนึ่งบัญชีหรือมากกว่าที่เชื่อมโยงกับ cTID ของพวกเขา

เมื่อผู้ใช้เลือกปุ่ม Allow access พวกเขาจะถูกเปลี่ยนเส้นทางกลับไปยัง redirect_uri ที่คุณระบุไว้เดิม ดังที่แสดงในตัวอย่างด้านล่าง รหัสอนุญาตจะถูกเพิ่มเข้าไปใน URI นี้เป็นพารามิเตอร์คำถาม

https://my-redirect-uri.com/?code=123ASDASffdg_as234_GCllkoq14adRB7_tvN

ณ จุดนี้ แอปพลิเคชันของคุณจะต้องเข้าถึงและเก็บค่าของพารามิเตอร์ code จะต้องถูกแลกเปลี่ยนเป็นโทเค็นการเข้าถึงอย่างรวดเร็วก่อนที่รหัสอนุญาตจะหมดอายุ

รับโทเค็นการเข้าถึง ¶

เพื่อรับโทเค็นการเข้าถึง ให้ทำการเรียก REST API ต่อไปนี้

คำขอนี้รวมพารามิเตอร์คำถามต่อไปนี้

ตัวอย่างคำขอสามารถพบได้ด้านล่าง

curl -X GET 'https://openapi.ctrader.com/apps/token?grant_type=authorization_code&code=0ssdgds98as9_QSF56FVC_22dfdf&redirect_uri=https://spotware.com&client_id=5430012&client_secret=012sds23dlkjQsd' -H 'Accept: application/json' -H 'Content-Type: application/json'

เพื่อดู client_secret ของคุณ กลับไปที่หน้า Applications และเลือกปุ่ม View ในคอลัมน์ Credentials

เมื่อคำขอสำเร็จ คุณควรได้รับคำตอบที่มีคีย์ต่อไปนี้

สำหรับตัวอย่างการตอบกลับที่สำเร็จ โปรดดูตัวอย่างด้านล่าง

{
    "accessToken":"mos8Bw3D4EG0fRPd4Eqq0JxaFT4zjd8e4YijNezh_ag",
    "tokenType":"bearer",
    "expiresIn":2628000,
    "refreshToken":"VCuafFhy81AFZjsWkbuEzdOhhRj5YTWz8fWUwHam7KM",
    "errorCode":null,
    "description":null,
}

ส่งข้อความ ProtoBuf ที่จำเป็น ¶

หลังจากได้รับรหัสการเข้าถึงที่ถูกต้อง แอปพลิเคชันของคุณจะต้องส่งข้อความ ProtoOAApplicationAuthReq, ProtoOAGetAccountListByAccessTokenReq และ ProtoOAAccountAuthReq สามารถทำได้ดังนี้

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40

private static RepeatedField<ProtoOACtidTraderAccount> _ctidTraderAccounts;

List<IDisposable> _disposables = new();
_disposables.Add(_client.OfType<ProtoOAGetAccountListByAccessTokenRes>().Subscribe(OnAccountIdReceived));

private static void OnAccountIdReceived(ProtoOAGetAccountListByAccessTokenRes response)
{

    Console.WriteLine($"\nMessage Received:\n{response}");

    _ctidTraderAccounts = response.CtidTraderAccount;

    var accountAuthReq = new ProtoOAAccountAuthReq
    {
        CtidTraderAccountId = (long)_ctidTraderAccounts[0].CtidTraderAccountId,
        AccessToken = _token.AccessToken,
    };

    _client.SendMessage(accountAuthReq);

}

var _client = new OpenClient(host, ApiInfo.Port, TimeSpan.FromSeconds(10), useWebSocket: false);
var applicationAuthReq = new ProtoOAApplicationAuthReq
{
    ClientId = {your_client_id}, // Add your client ID here
    ClientSecret = {your_app_secret}, // Add your app secret here
};
await _client.SendMessage(applicationAuthReq);
await Task.Delay(5000);
var getAccountListByAccessToken = new ProtoOAGetAccountListByAccessTokenReq 
{
    AccessToken = {access_token} // Add your access token here
}
var accountAuthReq = new ProtoOAAccountAuthReq 
{
    ctidTraderAccountId = {account_id}, // Add the ctidTraderAccountId of the account you want to authorize here
    AccessToken = {access_token} // Add your access token here
};
await _client.SendMessage(accountAuthReq);

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45

currentAccountId = None
client = Client(EndPoints.PROTOBUF_LIVE_HOST if hostType.lower() == "live" else EndPoints.PROTOBUF_DEMO_HOST, EndPoints.PROTOBUF_PORT, TcpProtocol)

def connected(client): # Callback for client connection
    print("\nConnected")
    request = ProtoOAApplicationAuthReq()
    request.clientId = appClientId
    request.clientSecret = appClientSecret
    deferred = client.send(request)



def disconnected(client, reason): # Callback for client disconnection
    print("\nDisconnected: ", reason)

def onMessageReceived(client, message): # Callback for receiving all messages
    global currentAccountId
    if message.payloadType in [ProtoOASubscribeSpotsRes().payloadType, ProtoOAAccountLogoutRes().payloadType, ProtoHeartbeatEvent().payloadType]:
        return
    elif message.payloadType == ProtoOAApplicationAuthRes().payloadType:
        print("API Application authorized\n")
        if currentAccountId is not None:
            sendProtoOAAccountAuthReq()
            return
        accountListReq = ProtoOAGetAccountListByAccessTokenReq()
        accountListReq.accessToken = accessToken
        deferred = client.send(accountListReq)
    elif message.payloadType == ProtoOAGetAccountListByAccessTokenRes().payloadType:
        protoOAGetAccountListByAccessTokenRes = Protobuf.extract(message)
        currentAccountId = int(protoOAGetAccountListByAccessTokenRes.ctidTraderAccount[0].ctidTraderAccountId)
        accountAuthReq = ProtoOAAccountAuthReq()
        accountAuthReq.ctidTraderAccountId = currentAccountId
        accountAuthReq.accessToken = accessToken
        deferred = client.send(accountAuthReq)
    elif message.payloadType == ProtoOAAccountAuthRes().payloadType:
        protoOAAccountAuthRes = Protobuf.extract(message)
        print(f"Account {protoOAAccountAuthRes.ctidTraderAccountId} has been authorized\n")
        print("This acccount will be used for all future requests\n")
    else:
        print("Message received: \n", Protobuf.extract(message))
    reactor.callLater(3, callable=executeUserCommand)

def onError(failure): # Call back for errors
    print("Message Error: ", failure)
    reactor.callLater(3, callable=executeUserCommand)

รีเฟรชโทเค็นการเข้าถึง ¶

หลังจากโทเค็นการเข้าถึงหมดอายุ คุณจะต้องต่ออายุโดยใช้ refreshToken ที่คุณได้รับก่อนหน้านี้ คุณสามารถดำเนินการนี้ได้ผ่านสองวิธีที่แตกต่างกัน

ส่งคำขอ HTTP¶

เพื่อรับโทเค็นการเข้าถึงใหม่ (และโทเค็นรีเฟรชใหม่ตามมา) คุณสามารถส่งคำขอ HTTP เดียวกัน ที่กล่าวถึงข้างต้น ดังที่แสดงในตัวอย่างด้านล่าง คุณจะต้องตั้งค่าพารามิเตอร์ grant_type เป็น refresh_token

curl -X POST 'https://openapi.ctrader.com/apps/token?grant_type=refresh_token&refresh_token=asdXCVCVAS_218kjashf_asdasd2ASD_223x&client_id=5430012&client_secret=012sds23dlkjQsd' -H 'Accept: application/json' -H 'Content-Type: application/json'

คุณจะได้รับคำตอบที่มีค่าใหม่ของคีย์ accessToken และ refreshToken คุณสามารถใช้ค่าใหม่เหล่านี้ได้อย่างปลอดภัย ในขณะที่ค่าเดิมของคีย์เดียวกันจะถูกยกเลิกโดยอัตโนมัติ

ส่งข้อความ Protobuf¶

หรือคุณสามารถส่งข้อความ ProtoOARefreshTokenReq และรับข้อความ ProtoOARefreshTokenRes ที่มีโทเค็นใหม่ที่ถูกต้อง

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16

_disposables.Add(_client.OfType<ProtoOARefreshTokenRes>().Subscribe(OnRefreshTokenResponse));
private static void OnRefreshTokenResponse(ProtoOARefreshTokenRes response) 
{
    _token = new Token 
    {
        AccessToken = response.AccessToken,
        RefreshToken = response.RefreshToken,
        ExpiresIn = DateTimeOffset.FromUnixTimeMilliseconds(response.ExpiresIn),
        TokenType = response.TokenType,
    }
}
var refreshTokenReq = new ProtoOARefreshTokenReq
    {
        refreshToken = {your_refresh_token}, // Add your refresh token here
    };
await _client.SendMessage(applicationAuthReq);

1

newToken = auth.refreshToken("refresh_Token")

ใช้ Playground ¶

Playground ให้วิธีการที่รวดเร็วในการรับโทเค็นการเข้าถึงสำหรับ cTID ของคุณเอง ช่วยให้คุณสามารถพัฒนาและทดสอบแอปพลิเคชันได้อย่างรวดเร็วและง่ายดายก่อนที่จะเผยแพร่ให้กับกลุ่มเป้าหมาย

เพื่อเข้าถึง Playground ให้ไปที่หน้า Applications และเลือกปุ่ม Playground ในหน้าต่างที่ปรากฏขึ้นใหม่ ให้เลือกขอบเขตของแอปพลิเคชันและคลิกปุ่ม Get token

หลังจากนั้น คุณควรเห็นหน้าต่อไปนี้

คุณสามารถใช้โทเค็นการเข้าถึงและโทเค็นรีเฟรชสำหรับการส่งข้อความไปยัง API ในขณะที่ได้รับการรับรองภายใต้ cTID ของคุณเอง