ステップ 1: API で認証する
コールを発行する前に API で認証する必要があります。
API が現在サポートしているのは、基本認証メカニズムのみです。後続の API コールで使用する認証トークンを取得するには、最初に認証サービスに対してコールを実行する必要があります。
1https://api-endpoint/auth/authenticateこのコールでは、認証チェックのための次の要求ヘッダーが返されます。
| パラメータ | 説明 |
|---|---|
| auth_user | アカウントのユーザ名 |
| auth_pass | プレーンテキストのパスワード |
| auth_appkey | ヘッダーパラメータに含める API キー |
すべてのパラメータは必須です。認証が成功すると、基本的なユーザアカウント情報とトークンタグが含まれる XML が次の形式で返されます。
1<token>70d756801c703f3e78f81726c11b00249fb81770a446958b2577cd223811e</token>このトークンを使用して、後続の API 要求を実行します。
1
2
3 <auth>
4
5 <token>e008252b4dce9b29c4c8155f0010cc8e128290b9e3ae99c8e9d15c
6
7 </token>
8
9 <UserDetails>
10
11 <user>
12
13 <userId>132972</userId>
14
15 <clientId>1226</clientId>
16
17 <displayName>Joe User</displayName>
18
19 <emailAddress>joe.user@radian6.com</emailAddress>
20
21 <packages />
22
23 </user>
24
25 <Packages>
26
27 <feature>
28
29 <featureId>1</featureId>
30
31 <description>Workflow</description>
32
33 </feature>
34
35 <feature>
36
37 <featureId>4</featureId>
38
39 <description>Admin Portal Full</description>
40
41 </feature>
42
43 <feature>
44
45 <featureId>6</featureId>
46
47 <description>Require PO Number</description>
48
49 </feature>
50
51 <feature>
52
53 <featureId>8</featureId>
54
55 <description>SENTIMENT</description>
56
57 </feature>
58
59 </Packages>
60
61 </UserDetails>
62
63 </auth>
64
65