이용약관 관리

현재 Apigee Edge 문서가 표시되고 있습니다.
Apigee X 문서로 이동 정보

소개

요금제를 게시하기 전에 조직 프로필에 이용약관 ('이용약관')을 추가해야 합니다. 이용약관은 조직 프로필 외부에 있습니다. 조직 프로필에서 이용약관의 위치 (공개 URL)를 지정합니다.

요금제를 게시하면 현재 버전의 이용약관이 개발자 포털에 표시됩니다. 개발자는 현재 이용약관에 동의한 후에만 요금제를 구매할 수 있습니다.

UI를 사용하여 이용약관 추가

  1. 조직 프로필 페이지 살펴보기에 설명된 대로 조직 프로필 페이지에 액세스합니다.
  2. 수정을 클릭합니다.
  3. 조직 프로필 페이지의 이용약관 섹션에서 이용약관 추가를 클릭합니다.

    새 이용약관 대화상자가 표시됩니다.

  4. 다음 정보를 입력합니다.
    필드 설명
    시행일

    이용약관의 효력을 나타내는 날짜입니다. 기본값은 현재 날짜입니다. 현재 또는 미래 날짜를 입력해야 합니다.
    버전

    이용약관의 버전입니다. 버전 번호를 통해 여러 버전의 이용약관을 추적할 수 있습니다.
    URL

    이용약관의 URL입니다.
  5. 만들기를 클릭합니다.

    새 이용약관은 조직 프로필 페이지의 이용약관 섹션에 추가됩니다.

  6. 3~5단계를 반복하여 이용약관을 추가합니다.
  7. 저장을 클릭하여 조직 프로필 변경사항을 저장합니다.

UI를 사용하여 이용약관 수정

이용약관을 직접 수정할 수는 없습니다. 대신 수정할 이용약관을 삭제한 다음 새 이용약관 항목을 추가해야 합니다.

UI를 사용하여 이용약관 삭제

  1. 조직 프로필 페이지 살펴보기에 설명된 대로 조직 프로필 페이지에 액세스합니다.
  2. 조직 프로필 페이지에서 수정을 클릭합니다.
  3. 이용약관 목록에서 삭제하려는 이용약관 위로 커서를 가져갑니다.
  4. 아이콘을 클릭합니다.

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를 사용하여 이용약관 보기

조직의 특정 이용약관 또는 모든 이용약관을 확인합니다.

/mint/organizations/{org_name}/tncs/{tncs_id}에 GET 요청을 실행하여 특정 이용약관을 확인합니다. 여기서 {tncs_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}는 이용약관 식별입니다. 업데이트할 때 업데이트된 설정과 이용약관 식별을 요청 본문에 지정해야 합니다. 예를 들어 다음 요청은 이용약관의 버전 번호를 수정합니다 (예시에서 업데이트된 속성이 강조표시됨).

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}는 이용약관 식별입니다. 예를 들면 다음과 같습니다.

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입니다.

 N/A No
tncText

이용약관에 관한 텍스트 (간단한 설명 등)입니다.

 N/A No
version

이용약관의 버전입니다. 버전 번호를 통해 여러 버전의 이용약관을 추적할 수 있습니다.

 N/A 지원됨
startDate

이용약관이 시행되는 날짜입니다.

 N/A 지원됨
organization

이용약관 조직입니다.

 N/A No

다음 단계

지원되는 통화 관리에서 지원되는 통화를 조직에 처음 설정한 통화에 추가하는 방법을 알아보세요.