• 最終編集日時: 25 March 2021

ユーザーAPI

ユーザーAPIを使用して、ユーザーデータの作成、更新、クエリを実行します。

ユーザーAPIを使用して、ユーザーデータを作成、更新、またはクエリします。 

APIにアクセスするためのURLは次のとおりです。https<instance> ://.cso.coupahost.com/api/users

詳細については、統合のベストプラクティスを参照してください。

アクション

動詞 パス アクション 説明
取得 /api/users index Getアクションを実行してすべてのユーザーを取得する
投稿 /api/users 作成 1つまたは複数のユーザーを作成します。
プット /api/users update 1つまたは複数のユーザーを更新します。大量のアップデートを実行できます。
取得 /api/users /: id 表示 ユーザーのデータを表示します。 
プット /api/users /: id 更新 IDを使用して一度に1人のユーザーを更新します

要素

これらは、ユーザーAPIで使用可能な要素です。

フィールド名 フィールドの説明 申請済み 一意ですか? 使用可能値 In アウト* タイプ
iD

ユーザーのID

  はい     はい 整数
都道府県 ユーザーのステータス    

ブロック済み、アクティブ、無効、削除済み(大文字と小文字を区別)

はい はい string
名前 ユーザーのログイン名。一度設定すると変更できません。   はい     はい string
first - name ユーザーのファーストネーム       はい    
last - name ユーザーのラストネーム       はい    
phone - number ユーザーの電話番号       はい はい string
mobile - number ユーザーの携帯電話番号       はい    
eメール ユーザーのメールアドレス。一度設定すると変更できません。         はい string
company - id ユーザーの会社ID。設定すると変更できなくなります            
street ユーザー住所の住所の一部       はい はい string
郵便番号 ユーザー住所の郵便番号の一部       はい はい string
市区町村 ユーザー住所の市区町村部分       はい はい string
ユーザーの住所の国の一部       はい はい string
keywords ユーザーに関連付けられているキーワード       はい はい string
external - user - name ユーザーに割り当てられた外部ユーザー名。         はい  
accepts - agreement ユーザーが必要な合意に同意したかどうかを示します。       はい はい  
provide - information ユーザーが次のログインでユーザー情報を提供するかどうかを示す。       はい はい  
change - password ユーザーが次のログインでパスワードを変更するかどうかを示します。       はい    
invoicing_user ユーザーに請求する 任意の はい boolean
メモ

 応答ペイロードはNULL値を表示しません。

この例では、User APIを照会しました。URLへのアクセスを行いました。 

https<instance> ://.cso.coupahost.com/api/users 

ユーザーGET回答

{

		"TOTAL ":3,

		"users ": [

				{

						"ID ":"9219595862193003588 ",

						"state ":"有効",

						"name ":" dekke 434 ",

						"first - name ":"アルジャン",

						"last - name ":"Goud ",

						"phone - number ": "+310987898789 ",

						"mobile - number ": "+31 (0) 6 98876554 ",

						"email ":" a.goud@deeder.com ",

						"company - id ":"9219592232917474305 ",

						"street ":"IJsseldijk west 66 ",

						"郵便番号":"2935 AR ",

						"city ":"Ouderkerk aan den IJssel ",

						"COUNTRY ":「オランダ」、

						"accepts - agreement ": false,

						"provide - information ": false,

						"change - password ": false

				},

				{

						"ID ":"9219595145795283441 ",

						"state ":"アクティブ",

						"name ":" deeed ",

						"first - name ":"アルジャン",

						"last - name ":"Deeed ",

						"phone - number ": "+313132323133 ",

						"email ":" mh@test.nl ",

						"company - id ":"9219592331212583950 ",

						"COUNTRY ":「オランダ」、

						"accepts - agreement ": false,

						"provide - information ": true,

						"change - password ": true

				},

				{

						"ID ":"9219592232917474526 ",

						"state ":"アクティブ",

						"name ":" eurot 494 ",

						"first - name ":"Marjus ",

						"LAST - NAME ":"ヴァン・ディー",

						"phone - number ": "+31121212121 ",

						"mobile - number ": "+31313131333 ",

						"email ":" test@test.com ",

						"company - id ":"9219592232917474528 ",

						"street ":"Brielselaan 69, Haven 1357 ",

						"郵便番号":"3081 AA ",

						"city ":「ロッテルダム」、

						"COUNTRY ":「オランダ」、

						"accepts - agreement ": false,

						"provide - information ": true,

						"change - password ": false

				}

	 ]

}

作成/更新

以下では、Coupa APIを使用してユーザーにアクションを実行する方法について説明します。

作成

/api/users

以下のペイロードは2人のユーザーを作成します。

ペイロード: 

{

		"users ": [

				{

						"state ":"アクティブ",

						"name ":" tester 123456 ",

						"first - name ":"テスター",

						"last - name ":"ユーザー1 ",

						"phone - number ": "+1 (111 )-234 -5678 ",

						"mobile - number ": "+1 (11 )-123 -3456 ",

						"email ":" testeruser@tester.com ",

						"company - id ":"9220538753250662192 ",

						"street ":"12345 bethoven road ",

						"郵便番号":"30811 ",

						"city ":「ロッテルダム」、

						"COUNTRY ":"米国",

						"accepts - agreement ": false,

						"provide - information ": true,

						"change - password ": false

				},

				 {

						"name ":" tester 12345 ",

						"first - name ":"テスト",

						"last - name ":"ユーザー",

						"phone - number ": "+1 (111 )-234 -5678 ",

						"mobile - number ": "+1 (11 )-123 -3456 ",

						"email ":" tester@tester.com ",

						"company - id ":"9220538753250662192 ",

						"street ":"12345 bethoven road ",

						"郵便番号":"30811 ",

						"city ":「ロッテルダム」、

						"COUNTRY ":"米国",

						"accepts - agreement ": true,

						"provide - information ": true,

						"change - password ": false

				}

		]

}

回答:201

{

		"result ": [

				{

						"type ":" api.post.added ",

						"description ":「2件のオブジェクトが作成されました。」

				}

		],

		"追加されました":2,

		"users ": [

				{

						"ID ":"9220538753483272432"

				},

				{

						"ID ":"9220538753482068122"

				}

		]

}	 

更新

/api/users

以下のペイロードはユーザーを更新します。 

一度に1人以上のユーザーを更新するには: 

ペイロード:

{

		"users ": [

				{

						"ID ":"9220538753483272432 ",

						"state ":"ブロックされました",

						"email ":" testeruser-upd@tester.com ",

						"accepts - agreement ": true,

						"provide - information ": true,

						"change - password ": false

				},

				{

						"ID ":"9220538753482068122 ",

						"state ":"ブロックされました",

						"email ":" tester-upd@tester.com ",

						"accepts - agreement ": false,

						"provide - information ": true,

						"change - password ": false

				}

		]

}



回答:200 OK

{

		"result ": [

				{

						"type ":" api.put.updated ",

						"description ":"2件のオブジェクトが更新されました。"

				}

		],

		"更新済み":2

}
メモ

 更新は寛大な方法で行われます。つまり、1つのリソースの更新に失敗した場合、他のリソースの更新は成功する可能性があります。更新にはユーザーIDが必要です。

要求が成功すると、HTTP 200応答が返されます。レスポンスの本文には、作成された申請書が含まれます。要求が失敗すると、HTTP 400 Bad Requestが返されます。応答の本文には、XML形式の検証エラーが含まれます。

関連アイテム


ファクトシートAPI

25 March 2021

ファクトシートAPIを使用して、ファクトシートと関連する(行/フィールド)データを作成、更新、またはクエリします。

フィールドAPI

25 March 2021

フィールドAPIを使用して、フィールドと関連付けられた(行)データを作成、更新、またはクエリします。

マーケットAPI

25 March 2021

マーケットAPIを使用して、マーケットの作成、更新、クエリを実行します。

会社のAPI

25 March 2021

会社のAPIを使用して、会社のデータを作成、更新、またはクエリします。