API 인증
기능 가용성
Snyk API를 사용하려면 엔터프라이즈(Enterprise) 플랜 고객이어야 하며 Snyk에서 발행한 토큰이 있어야 합니다.
API를 호출할 때는 해당 지역의 URL을 사용하십시오. API URL(API URLs)을 참조하십시오.
엔터프라이즈 사용자는 프로필에서 개인 토큰 및 서비스 계정 토큰에 액세스할 수 있습니다. 개인 API 토큰은 Snyk 계정과 연결되어 있으며 특정 조직(Organization)에 귀속되지 않습니다. 서비스 계정은 조직 또는 그룹(Group)과 연결됩니다. 자세한 내용은 서비스 계정(Service accounts)을 참조하십시오.
엔터프라이즈 사용자는 모든 종류의 자동화를 위해 서비스 계정을 사용하여 인증해야 합니다. 여기에는 CLI 또는 빌드 시스템 플러그인을 사용한 CI/CD 스캔, API를 사용한 자동화를 포함한 모든 자동화가 포함되지만 이에 국한되지 않습니다.
엔터프라이즈 사용자는 다음과 같은 경우에 사용자 프로필의 개인 토큰을 사용해야 합니다.
로컬 머신에서 CLI 실행. 자세한 내용은 CLI 사용을 위한 인증(Authenticate to use the CLI)을 참조하십시오.
IDE에서 수동으로 인증
무언가를 테스트하기 위해 일회성으로 API 호출 실행
무료(Free) 및 팀(Team) 플랜 사용자의 경우 개인 토큰으로 API에 액세스할 수 없으며, IDE, CLI 및 CI/CD 통합 인증용으로만 사용할 수 있다는 점에 유의하십시오. 자세한 내용은 API 토큰 획득 및 사용(Obtain and use your API token)을 참조하십시오.
추가 정보는 사용자가 제어할 수 있는 Snyk API 토큰 권한(Snyk API token permissions users can control)을 참조하십시오.
개인 토큰 획득 방법
Snyk에 가입하고 로그인한 후 개인 계정 설정(Personal account settings)에서 개인 API 토큰을 찾을 수 있습니다. key 필드에서 Click to show를 클릭하십시오. 그런 다음 API 키를 강조 표시하고 복사합니다.
새로운 API 토큰을 원하는 경우 Revoke & Regenerate를 선택하십시오. 이렇게 하면 이전 API 토큰이 무효화됩니다. 자세한 내용은 Snyk API 토큰 취소 및 재생성(Revoke and regenerate a Snyk API token)을 참조하십시오.
개인 API 토큰으로 인증
API를 직접 사용할 때는 다음 요청 예시와 같이 Authorization: token 헤더에 API 토큰을 입력하십시오. API_TOKEN 부분을 본인의 토큰으로 바꿉니다.
Snyk Apps 인증
Snyk Apps API를 사용하는 경우 다음과 같이 Authorization: bearer 헤더에 access_token을 입력하십시오.
그렇지 않으면 401 Unauthorized 오류가 반환됩니다.
Last updated