> For the complete documentation index, see [llms.txt](https://help.aximo.autify.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.aximo.autify.com/features-ko/test-execution-and-plans/api-cicd-integration.md).

# API 트리거로 실행

Aximo의 API 트리거를 사용하면 CI/CD 파이프라인이나 임의의 스크립트에서 케이스나 플랜을 실행할 수 있습니다.

API의 엔드포인트, 요청 본문, 응답, 상태 값의 자세한 내용은 Aximo Docs의 [API Reference](https://aximo.autify.com/docs/api) 참조. 기존 케이스를 API에서 삭제하려는 경우에도 같은 API Reference의 케이스 관련 엔드포인트를 참조하십시오.

## 사전 조건

* API 키를 발급한 상태 ([API 키 관리](/features-ko/settings/api-key-management.md) 참조)
* 실행 대상의 케이스 또는 플랜에서 **API 접근**을 활성화한 상태

{% hint style="warning" %}
API 접근을 활성화하지 않은 케이스·플랜은 API에서 실행할 수 없습니다.
{% endhint %}

## API 접근 활성화

케이스와 플랜의 **API 트리거** 대화상자에서 API 접근의 켜기/끄기를 전환합니다. API 엔드포인트, 상태 확인용 샘플 `curl` 명령어도 동일한 대화상자에서 확인할 수 있습니다.

케이스와 플랜의 작업 기점이 다를 뿐, 대화상자 내의 절차는 공통입니다.

### 케이스의 API 접근 활성화

1. 워크스페이스에서 **케이스** 탭을 열고 대상 케이스를 여십시오.
2. 케이스 상세 오른쪽 상단의 **API 트리거**를 클릭하십시오.
3. **API 접근**을 켜십시오.

<figure><img src="/files/KCF9IY9S1JoAQsitxgbD" alt="케이스의 API 트리거 대화상자 스크린샷"><figcaption><p>케이스의 API 트리거 대화상자</p></figcaption></figure>

4. 표시된 **API 엔드포인트**와 **사용 방법** 및 **상태 확인** 샘플 `curl` 명령어를 기록해 두십시오.
5. (모바일 케이스만) **모바일 설정**에서 API 경유 실행에 사용할 기기와 앱을 저장하십시오.
6. API 키가 없는 경우 **API 키 관리**에서 API 키를 만드십시오 ([API 키 관리](/features-ko/settings/api-key-management.md) 참조).

### 플랜의 API 접근 활성화

1. 워크스페이스에서 **플랜** 탭을 열고 대상 플랜을 여십시오.
2. 플랜 상세 오른쪽 상단의 **API 트리거**를 클릭하십시오.
3. **API 접근**을 켜십시오.

<figure><img src="/files/FeS368L6LTpOR4Je45RK" alt="플랜의 API 트리거 대화상자 스크린샷"><figcaption><p>플랜의 API 트리거 대화상자</p></figcaption></figure>

4. 표시된 **API 엔드포인트**와 **사용 방법** 및 **상태 확인** 샘플 `curl` 명령어를 기록해 두십시오.
5. (모바일 케이스를 포함하는 플랜만) 플랜 측의 **앱 및 기기**에서 실행에 사용할 기기와 앱을 설정하십시오 ("플랜 관리"의 [모바일 설정 관리](https://help.aximo.autify.com/features-ko/test-execution-and-plans/pages/VFIV1x6AfapCPx3lUuMt#모바일-설정-관리) 참조).
6. API 키가 없는 경우 **API 키 관리**에서 API 키를 만드십시오 ([API 키 관리](/features-ko/settings/api-key-management.md) 참조).

{% hint style="info" %}
모바일 케이스를 API에서 실행할 때 사용하는 기기·앱은 케이스나 플랜에 저장해 두면 API 요청별 지정을 생략할 수 있습니다.
{% endhint %}

## CI/CD 파이프라인 통합

API 키는 기밀 정보이므로 CI/CD의 시크릿 스토어에 등록하고 환경 변수로 전달하십시오. 케이스 ID나 플랜 ID도 필요에 따라 CI/CD 측의 변수로 관리하십시오.

CI/CD에서는 다음 흐름으로 Aximo 실행을 통합합니다.

1. API 키를 시크릿으로 등록하십시오.
2. 케이스 또는 플랜의 API 엔드포인트를 Aximo의 **API 트리거** 대화상자에서 확인하십시오.
3. CI/CD의 단계에서 API 엔드포인트를 호출하십시오.
4. 응답에 포함된 ID를 사용해 상태 엔드포인트를 정기적으로 호출하십시오.
5. 실행 결과에 따라 CI/CD 작업을 성공 또는 실패로 처리하십시오.

{% hint style="info" %}
API 호출 형식이나 상태 판정 구현 예시는 [API Reference](https://aximo.autify.com/docs/api)의 "Triggering Existing Test Cases", "Triggering Test Plans", "Polling & Terminal Statuses" 참조.
{% endhint %}

## 문제 해결

### `401 Unauthorized`가 반환됨

**원인**: `x-api-key` 헤더가 지정되지 않았거나 API 키가 유효하지 않습니다.

**조치**: API 키 관리 화면에서 키가 유효한지 확인하십시오. 시크릿 스토어에 등록한 값을 다시 확인하고, 필요에 따라 새 키를 발급하십시오.

### `403 API access is not enabled for this case` / `for this plan`이 반환됨

**원인**: 대상 케이스·플랜에서 API 접근이 비활성화되어 있습니다.

**조치**: 대상 케이스 상세 또는 플랜 상세에서 **API 트리거**를 열고 **API 접근**을 켜십시오.

## 참고 자료

* [API Reference](https://aximo.autify.com/docs/api)
* [API 키 관리](/features-ko/settings/api-key-management.md)
* [플랜 관리](/features-ko/test-execution-and-plans/test-plan-specifications.md)
* [케이스 만들기](/features-ko/test-case-creation/create-test-case.md)
