1.7. 3scale 관리 API의 개발자 포털에 대한 액세스 허용 요구 사항

원하는 모양과 느낌을 갖도록 3scale 기본 개발자 포털을 변경합니다.

HTML, CSS, Liquid 및 웹 사이트에 익숙한 개발자는 일반적으로 기본 Echo API 개발자 포털을 수정하여 개발자 포털 웹 페이지를 만들 수 있습니다. 이 개발자는 시스템 생성 페이지에서 페이지를 생성하고 개발자 포털에서 API 소비자가 표시할 모든 항목을 생성할 수 있습니다.

3scale API 제품, 백엔드 및 애플리케이션 계획을 정의하고 제품에 정책을 할당합니다.

3scale 제품은 API를 소비자에게 노출하는 3scale 리소스입니다. 개발자 포털에서 API 소비자는 제품에 대한 설명서를 읽고 제품이 제공하는 API를 구독합니다. 3scale 제품에는 다음과 같은 특성이 있습니다.

관리 포털 가이드 참조.

3scale 관리 API를 정의하고 문서화하는 OpenAPI 문서를 가져옵니다.

개발자 포털의 기반은 API를 정의하는 OpenAPI 문서입니다. OpenAPI 문서를 3scale으로 가져올 때 3scale은 ActiveDocs를 생성하거나 업데이트하므로 API에 대한 기능 설명서를 즉시 사용할 수 있습니다. 개발자 포털에서 API 소비자는 이 설명서를 사용하여 API를 탐색, 테스트 및 통합합니다.

OpenAPI 문서에 정의된 각 작업에 대해 문서를 가져오면 3scale에서 메서드와 매핑 규칙을 생성합니다. 메서드 및 매핑 규칙은 API 소비자 액세스에 대한 제한 및 규칙을 적용하는 데 도움이 됩니다.

3scale 가이드인 개발자 포털의 API 제공 에는 3scale 및 OpenAPI 문서를 사용하기 위한 정보와 절차가 포함되어 있습니다. 특히 3scale 사양으로 사용할 OpenAPI 문서를 작성하는 방법과 3scale 에 ActiveDocs 추가를 참조하십시오.

API 소비자가 3scale 관리 API에 액세스하기 위해 등록하는 방법에 대한 워크플로를 구성합니다.

가입 워크플로는 개발자 포털에서 API 소비자 환경에서 중요한 측면입니다. 워크플로는 셀프 서비스에서 누가 무엇을 액세스할 수 있는지를 완벽하게 제어할 수 있습니다. 계정, 서비스 및 애플리케이션 계획은 여러 수준의 단위를 제공합니다. 각 수준에서 운영하는 승인 게이트가 있는지 여부와 API 소비자가 어떤 선택을 해야 하는지 여부를 제어합니다.

자동화 및 셀프 서비스를 극대화하기 위해 모든 승인 단계를 제거하고 가능한 모든 기본 계획을 활성화할 수 있습니다. 등록 직후 개발자 포털에서 개발자 포털에 대한 API 소비자 액세스 권한을 제공하는 키를 발행할 수 있습니다.

기본 개발자 포털에서는 사용자, 계정 및 애플리케이션 등록에 일반적으로 사용되는 필드를 제공합니다. 일반적으로 사용되는 필드에 사용자 지정 필드를 추가해야 할 수 있습니다. 자세한 내용은 등록 흐름 구성 및 사용자 정의 등록 양식 필드를 참조하십시오. 이메일 템플릿을 사용자 지정하기 전에 워크플로를 구성해야 합니다.

API 소비자 인증을 구현합니다.

개발자 포털에 대한 API 소비자 액세스 권한 인증은 개발자 포털 리소스와 API를 보호합니다. 다음 방법 중 하나를 사용하여 개발자 포털에 대한 액세스를 인증할 수 있습니다.

개발자 포털 인증을 참조하십시오.

개발자 포털과 API 소비자 간의 이메일 통신을 위한 3scale 네이티브 템플릿 사용자 지정.

다양한 이벤트에는 등록, 암호 복구, 서비스 요금, 변경 알림 등이 있을 때 계정 활성화 링크 제공 등 개발자 포털과 API 소비자 간의 통신이 필요합니다. 3scale은 개발자 포털이 API 소비자에게 보내는 각 일반 이메일 유형에 대한 템플릿을 제공합니다.

가입 워크플로를 정의한 후 이메일 메시지의 콘텐츠를 사용자 지정합니다. 이를 통해 개발자 포털에 설정한 워크플로를 긴밀하게 일치시킬 수 있습니다.

이메일 템플릿 및 리quids를 참조하십시오. 이메일 템플릿.

API 소비자가 3scale 관리 API 액세스에 대해 동의해야 하는 약관, 조건 및 정책을 지정합니다.

API 소비자가 API에 등록하여 API를 호출할 수 있도록 허용하면 일반적으로 액세스 권한을 부여하기 전에 사용 약관 및 정책에 동의하기를 원합니다. 예를 들어 등록하기 위해 또는 개발자 포털이 둘 이상의 서비스를 제공하는 경우 특정 서비스를 사용하기 위해 다양한 버전의 사용 약관을 보유할 수 있습니다.

API 사용에 대해 요금을 부과하는 경우 신용 카드 정책에 동의해야합니다.

사용 약관 설정을 참조하십시오.

API 소비자 청구 및 신용 카드 게이트웨이 설정.

3scale 청구 프로세스는 매일 실행됩니다. 유료 서비스를 서브스크립션하는 각 API 소비자 계정에 대한 송장을 만듭니다. 송장은 open, finalized, pending, unpaid, paid, failed, canceled 중 하나에 있을 수 있습니다. 3scale은 송장을 처리하도록 구성한 결제 게이트웨이를 사용합니다.

3scale 청구 프로세스는 선불 또는 선불 모드로 실행될 수 있습니다. 3scale의 청구는 월을 기준으로 하며 매월 첫째 날에 발생하는 특수한 이벤트가 있습니다.

관리 포털 가이드, 청구 가이드 참조.