4.5. ActiveDocs API 키 자동 입력

API 키 자동 입력은 3scale ActiveDocs에서 OAS를 확장하는 데 유용합니다. API 인증 모드에 따라 다음 값을 사용하여 x-data-threescale-name 필드를 정의할 수 있습니다.

  • user_keys: API 키 인증만 사용하는 서비스 애플리케이션에 대한 사용자 키를 반환합니다.
  • app_ids: App ID/App Key를 사용하는 서비스 애플리케이션의 ID를 반환합니다. 이전 버전과의 호환성을 위해 OAuth 및 OpenID Connect도 지원됩니다.
  • app_keys: App ID/App Key를 사용하는 서비스 애플리케이션에 대한 키를 반환합니다. 이전 버전과의 호환성을 위해 OAuth 및 OpenID Connect도 지원됩니다.

API 키 인증 예

다음 예제에서는 API 키 인증에만 "x-data-threescale-name": "user_keys" 를 사용하는 방법을 보여줍니다.

"parameters": [
  {
    "name": "user_key",
    "description": "Your access API Key",
    "type": "string",
    "in": "query",
    "x-data-threescale-name": "user_keys",
    "required": true
  },
]
앱 ID/App 키 인증 예

x-data-threescale-name 필드는 ActiveDocs 도메인 외부에서 무시되는 OAS 확장입니다.

App ID/App 키 인증 모드는 애플리케이션 ID를 나타내는 매개 변수에 "x-data-threescale-name": "app_ids" 를 지정하고 애플리케이션 키를 나타내는 매개 변수에 "x-data-threescale-name": "app_keys" 를 지정합니다.

매개 변수를 선언하면 ActiveDocs 사용자에게 다음 스크린샷과 같이 자동으로 Developer Portal에 로그인하라는 메시지가 표시됩니다.

로그인하지 않을 때 자동 채우기

사용자가 이미 로그인한 경우 ActiveDocs는 키 복사 및 붙여넣기 없이도 즉시 테스트할 수 있도록 관련된 최신 5개의 키를 표시합니다.

로그인 시 자동 채우기