このページは Cloud Translation API によって翻訳されました。

利用規約を管理する

Apigee Edge のドキュメントを表示しています。
Apigee X のドキュメントに移動。情報

はじめに

料金プランを公開する前に、組織のプロフィールに利用規約（「利用規約」）を追加する必要があります。利用規約は組織プロファイルの外部にあります。組織のプロファイルで、利用規約の場所（公開 URL）を指定します。

料金プランを公開すると、デベロッパーポータルに利用規約の最新バージョンが表示されます。デベロッパーは、現在の利用規約に同意した後でのみプランを購入できます。

UI を使用して利用規約を追加する

組織のプロフィールページの確認の説明に沿って、組織のプロフィールページにアクセスします。
[編集] をクリックします。
組織のプロフィールページの [利用規約] セクションで、[利用規約を追加] をクリックします。
[新しい利用規約] ダイアログが表示されます。

次の情報を入力します。

フィールド	説明
発効日	利用規約の発効日。デフォルトは現在の日付です。現在または将来の日付を入力してください。
バージョン	利用規約のバージョン。バージョン番号を使用すると、利用規約のさまざまなバージョンを追跡できます。
URL	利用規約の URL。

[作成] をクリックします。
新しい利用規約が、組織のプロフィールページの [利用規約] セクションに追加されます。
手順 3 ～ 5 を繰り返して、利用規約を追加します。
[Save] をクリックして、組織プロファイルの変更を保存します。

UI を使用した契約条件の編集

利用規約は直接編集できません。代わりに、編集する利用規約を削除してから、新しい利用規約エントリを追加する必要があります。

UI を使用した利用規約の削除

組織のプロフィールページの確認の説明に沿って、組織のプロフィールページにアクセスします。
組織のプロフィールページで [編集] をクリックします。
利用規約のリストで、削除する利用規約にカーソルを合わせます。
[] をクリックします。

API を使用した利用規約の管理

以降のセクションで説明するように、API を使用して利用規約を管理します。

API を使用して利用規約を追加する

/mint/organizations/{org_name}/tncs に POST リクエストを発行して、利用規約を追加します。利用規約を追加する際に、必要に応じて次の項目を指定できます。

URL
付随するテキスト（説明など）
利用規約の発効日
バージョン番号

これらのオプションの詳細については、利用規約の構成プロパティをご覧ください。

例:

curl -X POST   "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/tncs" \
  -H "Content-Type: application/json" \
  -d \
  '{
     "url":"www.testoperator/termsandconditions",
     "tncText":"Sample text for the T&C",
     "version":"1.1",
     "startDate":"2018-09-24"
  }' \
  -u email:password

レスポンスの例を次に示します。

{
   "id" : "6803d70a-18cc-40c8-b250-675c5e8a75c ",
   "organization" : {     
     …
   },
   "startDate" : "2018-09-24 00:00:00",
   "tncText" : "Sample text for the T&C",
   "url" : "www.testoperator/termsandconditions",
   "version" : "1.1"
 }

API を使用した利用規約の表示

組織の特定の利用規約またはすべての利用規約を表示します。

特定の利用規約を表示するには、GET リクエストを /mint/organizations/{org_name}/tncs/{tncs_id} に発行します。ここで、{tncs_id} は特定の利用規約の ID です（利用規約を作成すると、レスポンスで ID が返されます）。例:

curl -X GET "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/tncs/6803d70a-18cc-40c8-b250-675c5e8a75c" \
  -H "Accept: application/json"  \
  -u email:password

/mint/organizations/{org_name}/tncs に GET リクエストを発行して、組織のすべての利用規約を表示します。例:

curl -X GET "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/tncs" \
  -H "Accept: application/json" \
  -u email:password

レスポンスの例を次に示します。

{

"tnc" : [
  {
    "id" : "77193339-8d79-44a8-8af2-3593f16c158e",
    "organization" :
    {
      ...
    },
   "startDate" : "2018-07-01 00:00:00",
   "tncText" : "Big operator text for the T&C",
   "url" : "www.bigoperator/termsandconditions",
   "version" : "1.0"
  },
  {
    "id" : "6803d70a-18cc-40c8-b250-675c5e8a75c3",
    "organization" : {
    ...
  },
    "startDate" : "2018-09-24 00:00:00",
    "tncText" : "Sample text for the T&C",
    "url" : "www.testoperator/termsandconditions",
    "version" : "1.1"
  }
  ]
   "totalRecords" : 2
}

API を使用して、デベロッパーまたは会社の利用規約文書に同意する

次のいずれかの API に対して POST リクエストを発行して、特定のデベロッパーまたは会社の利用規約文書をそれぞれ受け入れます。

/mint/organizations/{org_name}/developers/{dev_id}/tncs/{tncs_id}/developer-tncs
/mint/organizations/{org_name}/companies/{company_id}/tncs/{tncs_id}/developer-tncs

ここで、{dev_id} はデベロッパー ID（メールアドレス）、{company_id} は会社 ID、{tncs_id} は利用規約ドキュメント ID です。

例:

curl -X POST "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/dev2@myorg.com/tncs/5a291b86-42e3-4ae1-8db3-efe4b0877316/developer-tncs" \
  -H "Content-Type: application/json" \
  -d \
  '{
     "action":"ACCEPTED",
     "auditDate":"2018-10-01 00:00:00"
  }' \
  -u email:password

レスポンスの例を次に示します。

注: レスポンスペイロードでは、auditDate は UTC の現在の時刻に設定されます。

{
  "action": "ACCEPTED",
  "auditDate": "2018-10-01 07:24:45",
  "id": "dev2@myorg.com",
  "tnc": {
      "id": "5a291b86-42e3-4ae1-8db3-efe4b0877316",
      ...
  }
}

API を使用してデベロッパーまたは企業が同意した利用規約の表示

特定のデベロッパーまたは会社が同意した利用規約を表示するには、次のいずれかの API に GET リクエストを発行します。

/mint/organizations/{org_name}/developers/{dev_id}/developer-tncs
/mint/organizations/{org_name}/companies/{company_id}/developer-tncs

ここで、{dev_id} はデベロッパー ID（メールアドレス）、{company_id} は会社 ID です。

例:

curl -X GET "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/dev2@myorg.com/developer-tncs" \
  -H "Accept:application/json"  \
  -u email:password

レスポンスの例を次に示します。

{
  "developerTnc": [
  {
    "action": "ACCEPTED",
    "auditDate": "2018-08-29 07:24:45",
    "id": "dev2@myorg.com",
    "tnc": {
      "id": "26abc14c-c628-4c38-8840-a343c8ee9437",
      ...
    }
  }],
  "totalRecords": 1
}

API を使用した利用規約の編集

/mint/organizations/{org_named}/tncs/{tncs_id} に PUT リクエストを発行して利用規約を編集します。ここで、{tncs_id} は利用規約の ID です。更新を行うときは、更新された設定と利用規約の ID をリクエスト本文で指定する必要があります。たとえば、次のリクエストは利用規約のバージョン番号を編集します（更新されたプロパティは例でハイライト表示されています）。

curl -X PUT "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/tncs/cfbb03b3-b707-495b-9b8a-ff67d71065a9" \
  -H "Content-Type: application/json" \
  -d {
    "id":"6803d70a-18cc-40c8-b250-675c5e8a75c",
    "version":"1.2"
  }' \
  -u email:password

レスポンスの例を次に示します。

{
   "id" : "cfbb03b3-b707-495b-9b8a-ff67d71065a9",
   "organization" : {
       "address" : [ {
       "address1" : "Test address",
       "city" : "Test City",
       "country" : "US",
       "id" : "test-address",
       "isPrimary" : true,
       "state" : "CA",
       "zip" : "54321"
     } ],
     …"
   },
   "startDate" : "2018-09-24 00:00:00",
   "tncText" : "Sample text for the T&C",
   "url" : "www.testoperator/termsandconditions",
   "version" : "1.2"
 }

API を使用して利用規約を削除する

/mint/organizations/{org_name}/tncs/{tncs_id} に DELETE リクエストを発行して利用規約を削除します。ここで、{tncs_id} は利用規約の ID です。例:

curl -X DELETE "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/tncs/6803d70a-18cc-40c8-b250-675c5e8a75c" \
  -H "Accept: application/json"  \
  -u email:password

API の利用規約の構成プロパティ

次の表に、利用規約の API を使用して設定できる構成プロパティを示します。

名前	説明	デフォルト	必須
`url`	利用規約の URL。	なし	いいえ
`tncText`	利用規約のテキスト（簡単な説明など）。	なし	いいえ
`version`	利用規約のバージョン。バージョン番号を使用すると、利用規約のさまざまなバージョンを追跡できます。	なし	はい
`startDate`	利用規約の発効日。	なし	はい
`organization`	利用規約の組織。	なし	いいえ

次のステップ

組織で最初に設定された通貨にサポートされている通貨を追加する方法については、サポートされている通貨を管理するをご覧ください。