플랫폼 REST API키 관리

온라인에서 편집하기

사용자 계정과 연결된 API 키를 생성한 다음, 이 키를 사용하여 에서 제공하는 플랫폼 REST API를 API Connect 호출할 때 인증을 수행하십시오.

이 태스크에 대한 정보

사용하려면 인증이 API Connect 플랫폼 REST API 필요합니다. 대화식으로 API를 호출하려면 API 키를 생성하는 옵션을 사용하여 툴킷 CLI에 로그인할 수 있습니다. API를 프로그래밍 방식으로 호출하려면 API 키를 생성한 다음, 이를 액세스 API Connect 토큰으로 교환할 수 있습니다. 이 요구 사항은 에서 제공하는 API ConnectAPI에만 적용됩니다. 가져오거나 작성한 API 호출에 API 키가 필요하지 않습니다. 이 API 키는 OIDC 사용자 레지스트리 유형과 함께 사용하도록 설계되었습니다.
참고: 기본적으로 API 키는 한 번만 사용하도록 설정되어 있습니다 하지만 ‘API 키 설정 구성’ 항목에 안내된 단계를 따르면 구성을 사용자 지정하고 API 키의 유효 기간을 변경할 수 있습니다

프로시저

  1. API 키를 작성하십시오.
    1. Enterprise as a API Connect Service에 로그인하세요.
    2. 배너에 있는 사용자 이름을 클릭하면 프로필이 표시됩니다.
    3. 프로필 페이지에서 ‘내 API 키’를 클릭하세요.
    4. API키 페이지에서 추가를 클릭하십시오.
    5. ‘ API Connect API 키 생성’ 필드에 키의 제목과 설명을 입력하세요. 제목은 해당 사용자 계정 내에서 고유해야 합니다.
    6. 타임아웃 값을 지정하려면 API 키 타임아웃 필드에서 정수 값을 선택하거나 직접 입력한 다음, 단위 필드에서 시간 단위(초, 분, 시간)를 선택하십시오.
      참고: 기본 시간 초과 값은 5분입니다.
    7. ‘다중 사용 허용’을 선택하면 애플리케이션이 API 키를 액세스 토큰으로 여러 번 교환할 수 있습니다.
    8. ‘만들기’를 클릭하세요.
      참고: 설명을 입력하기 전까지는 ‘생성’ 버튼이 비활성화됩니다.
  2. API키 관리:
    1. Enterprise as a API Connect Service에 로그인하세요.
    2. 배너에 있는 사용자 이름을 클릭하면 프로필이 표시됩니다.
    3. 프로필 페이지에서 ‘내 API 키’를 클릭하세요.
      사용자 계정에 연결된 API 키 목록이 표시됩니다:
      • 키를 보려면 키 제목이 있는 행을 API 키 보기 클릭하세요.
      • 키를 복사하려면 키를 확인한 다음 API 키 필드에서 API 키 복사 를 선택하세요.
      • 키를 삭제하려면 키 제목이 있는 행을 클릭한 API 키 삭제 다음, 확인 메시지가 표시되면 ‘삭제’를 클릭하세요.