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

API 사용자에게 개발자 포털에 대한 액세스 권한을 부여하려면 API 공급자가 다음 작업을 수행해야 합니다. 이러한 작업은 동시에 수행할 수 있습니다.

  • 원하는 모양과 느낌이 되도록 3scale 네이티브 개발자 포털을 변경합니다.

    • 유동성: Developer Portal 는 Liquid Markup을 사용하여 API와 관련된 3scale 시스템 데이터를 표시하고 처리하는 방법을 보여줍니다. Liquid Markup은 개발자 포털 페이지에 논리를 추가하는 기본 방법입니다.
    • 개발자 포털 레이아웃 사용자 정의에서는 기본 개발자 포털을 자체 브랜딩과 일치하도록 변경하는 방법을 설명합니다. 표준 cascading 스타일시트 (CSS)를 사용하여 사용자 정의를위한 간편한 시작 지점을 제공 할 수 있습니다.
    • 기본 제공 페이지 변경에서는 CSS 및 JavaScript를 사용하여 시스템 생성 페이지에서 요소를 수정하거나 숨기는 방법을 설명합니다. 기본 개발자 포털의 일부로 제공되는 모든 페이지를 시스템 생성 페이지라고 합니다.

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

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

    3scale 제품은 API를 소비자에게 노출하는 3scale 리소스입니다. 개발자 포털에서 API 소비자는 제품에 대한 문서를 읽고 제품에서 제공하는 API를 사용하도록 서브스크립션합니다. 3scale 제품에는 다음과 같은 특성이 있습니다.

    • 번들은 생성한 내부 3scale API인 백엔드 하나 이상 번들입니다.
    • 제한, 가격 및 사용 가능한 기능과 관련하여 제품을 사용하기 위한 규칙을 정의하는 애플리케이션 계획이 있습니다.
    • 게이트웨이가 API로 보내기 전에 API 소비자 호출을 처리하는 방법에 대한 APIcast 게이트웨이 구성이 있습니다. 제품에 추가하는 정책은 기본 APIcast 게이트웨이 동작을 변경합니다.

    관리 포털 가이드 를 참조하십시오.

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

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

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

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

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

    등록 워크플로는 개발자 포털에 대한 API 소비자 경험의 중요한 측면입니다. 워크플로는 셀프 서비스부터 액세스 권한을 얻은 사람에 대한 총 제어에 이르기까지 다양합니다. 계정, 서비스 및 애플리케이션 계획은 여러 수준의 세분성을 제공합니다. 각 수준에서 작동하는 승인 게이트와 API 소비자가 어떤 선택을 할 필요가 있는지 여부를 제어할 수 있습니다.

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

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

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

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

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

  • 개발자 포털과 API 소비자 간의 이메일 통신에 사용할 3scale 네이티브 템플릿을 사용자 지정합니다.

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

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

    이메일 템플릿Liquids를 참조하십시오. 이메일 템플릿.

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

    API 소비자가 API에 등록하고 호출하도록 허용하면 일반적으로 액세스 권한을 부여하기 전에 사용 약관 및 정책에 동의하도록 합니다. 개발자 포털에서 둘 이상의 서비스를 제공하는 경우(예: 특정 애플리케이션 사용 또는 특정 서비스 사용용) 다양한 용어 및 조건이 있을 수 있습니다.

    귀하의 API를 사용하기 위해 요금을 청구하는 경우, 귀하의 신용카드 정책에 동의하고 싶을 것입니다.

    용어 및 조건 설정을 참조하십시오.

  • API 소비자 청구 및 신용카드 게이트웨이를 설정합니다.

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

    3scale 청구 프로세스는 선불 또는 취소 모드로 실행될 수 있습니다. 3scale의 청구는 월에 따라 청구되며 해당 월의 첫 번째 날에 발생하는 특수 이벤트가 있습니다.

    관리 포털 가이드, 청구 를 참조하십시오.

개발자 포털이 활성화되기 전에 마지막으로 수행해야 하는 작업은 액세스 코드를 제거하는 것입니다. 개발자 포털에 대한 액세스 권한을 위해 인증 후, 개발자 포털을 철저하게 테스트한 후만 수행하여 원하는 대로 작동하는지 확인합니다.

액세스 코드를 삭제하려면 개발자 포털 > 콘텐츠 환경을 표시합니다. 오른쪽 하단에서 Open your Portal to the world 를 클릭하고 이 작업을 확인합니다.