REST API 시작하기

명령줄에서 curl을 사용하여 REST API에 대한 간단한 호출을 수행하려면 다음 단계를 따르십시오.

1. Snyk에 로그인합니다.

2. 계정에서 왼쪽 탐색창을 사용하여 프로젝트 목록을 확인할 수 있는 **조직(Organization)**을 찾습니다.

3. **조직 설정(Organization Settings)**으로 이동하여 일반(General) 설정 페이지에서 **조직 ID(Organization ID)**를 찾아 값을 복사합니다.

4. 개인 일반 계정 설정(General Account Settings)으로 이동하여 **API 토큰(API Token)**을 복사합니다. 지침은 API 인증(Authentication for API)을 참조하십시오.

5. curl 명령을 사용하여 요청을 보냅니다. {orgId} 및 API_TOKEN을 각각 복사한 조직 ID 및 API 토큰으로 바꿉니다. Snyk은 특정 이유로 이전 버전을 사용해야 하는 경우가 아니라면 버전 번호로 2024-10-15를 사용할 것을 권장합니다. 현재 날짜를 사용하면 API의 가장 최신 버전이 호출됩니다. 예시는 다음과 같습니다.

curl --request GET \
--url "https://api.snyk.io/rest/orgs/{orgId}/projects?version=2024-10-15" \
--header "Content-Type: application/vnd.api+json" \
--header "Authorization: token API_TOKEN"

API 호출 시 사용할 API URL은 지역마다 다릅니다. 전체 목록은 API URL(API URLs)을 참조하십시오.

예를 들어, SNYK-US-02 지역의 API URL은 다음과 같습니다.

• API V1: https://api.us.snyk.io/v1/

• REST API: https://api.us.snyk.io/rest/

target-reference 매개변수를 사용하는 경우 URL 인코딩을 해야 한다는 점에 유의하십시오.

문제나 질문이 있는 경우 Snyk 지원팀(Snyk support)에 문의하십시오.