# API 사용하기

💬 이 내용은 **스탠다드, 프로, 엔터프라이즈 요금제**에 해당하는 도움말입니다.

## 이 글에서는 <a href="#h_01hrp9h7hbxw06bj9p21fev150" id="h_01hrp9h7hbxw06bj9p21fev150"></a>

API키 생성부터 사용할 수 있는 연동 종류까지 스티비에서 제공하는 API를 사용하기 위해 기본적으로 알아야 하는 내용에 대해 알아봅니다.

{% hint style="info" %}
API에 대한 요청 및 응답 방법은 [스티비 API 문서](https://developers.stibee.com/)에서 확인하고 테스트할 수 있습니다.
{% endhint %}

***

## API 종류 <a href="#id-1-api" id="id-1-api"></a>

스티비에서 제공하는 API는 크게 '이메일'과 '주소록' 두 가지로 나뉩니다.&#x20;

* 이메일 API: 이메일을 생성하거나 콘텐츠를 수정하고 발송할 수 있으며, 발송한 이메일의 통계를 조회할 수 있습니다.
* 주소록 API: 주소록을 생성하거나 정보를 수정할 수 있고 주소록에 구독자를 추가하거나 정보를 수정할 수 있습니다. 주소록에 구독자를 나눠서 관리할 수 있는 \[[그룹](/list/classify-subscribers/how-to-use-groups.md)]을 만들거나 수정할 수 있고 주소록에 발신자 이메일 주소를 추가하거나 삭제할 수 있습니다.

## 시작하기 <a href="#id-1-api" id="id-1-api"></a>

### API 키 만들기 <a href="#id-1-api" id="id-1-api"></a>

API를 사용하기 위해서는 API 키를 만들어야 합니다. API는 워크스페이스 단위로 관리되므로 \[워크스페이스 이름 → 워크스페이스 설정 → API 키]에서 \[+새로 만들기]를 눌러 API 키를 생성할 수 있습니다.

<figure><img src="/files/W5VDAl02HWiRt1lT5ZA0" alt=""><figcaption></figcaption></figure>

\[+새로 만들기]를 클릭해서 API 키를 생성한 뒤, \[복사하기]를 누르면 API 키를 복사할 수 있습니다. 이 키는 API 요청 시 토큰으로 사용됩니다. API 키는 최대 10개까지 생성할 수 있습니다.

**\*주의:** API 키가 노출되면 워크스페이스 보안에 치명적인 문제가 생길 수 있습니다. API 키 노출이 의심된다면 의심되는 키를 비활성화하거나 삭제한 뒤, 새로운 키를 만들어서 사용해 주세요.

<figure><img src="/files/4jQPNbfsfCxWs3RqthDe" alt=""><figcaption></figcaption></figure>

### API 요청에 필요한 키 값 확인하기

API 요청을 보낼 때 어떤 이메일, 주소록, 그룹 등에 대한 요청인지 구체적으로 지정해야 합니다. 각 이메일, 주소록, 그룹은 고유의 ID 값을 가지고 있고 이 ID는 브라우저의 URL에서 확인할 수 있습니다.

#### emailId(이메일 ID)

emailId는 이메일에 할당된 고유의 아이디입니다. 아래 방법으로 확인할 수 있습니다.

1. 이메일 목록에서 ID를 확인하고 싶은 이메일의 이름을 클릭하여 편집 화면 또는 \[이메일 대시보드]로 이동
2. 브라우저에 표시되는 URL에서 'email' 뒤의 숫자를 확인(예: <https://stibee.com/email/123456/>... 일 때  emailid는 email 뒤에 있는 123456)

#### listId(주소록 ID)

listId는 주소록에 할당된 고유의 아이디입니다. 아래 방법으로 확인할 수 있습니다.

1. 주소록 목록에서 주소록 이름을 클릭하여 \[주소록 대시보드]로 이동
2. 브라우저에 표시되는 URL에서 'lists' 뒤의 숫자를 확인 (예: <https://stibee.com/lists/123456/>... 일 때 listid는 lists 뒤에 있는 123456)

#### groupId(그룹 ID)

groupId는 그룹에 할당된 고유의 아이디입니다. 아래 방법으로 확인할 수 있습니다.

1. 주소록 목록에서 주소록 이름을 클릭하여 \[주소록 대시보드]로 이동
2. \[그룹]을 클릭하여 그룹 목록으로 이동
3. 그룹 이름을 클릭하여 그룹 필터링이 적용된 구독자 목록으로 이동
4. 브라우저에 표시되는 URL에서 'S' 뒤의 숫자를 확인(예: <https://stibee.com/lists/123456/subscribers/S/789012> 일 때 groupId는 S 뒤에 있는 789012)

#### segmentId(세그먼트 ID)

segmentId는 세그먼트에 할당된 고유의 아이디입니다. 아래 방법으로 확인할 수 있습니다.

1. 주소록 목록에서 주소록 이름을 클릭하여 \[주소록 대시보드]로 이동
2. \[세그먼트]를 클릭하여 세그먼트 목록으로 이동
3. 세그먼트 이름을 클릭하여 세그먼트 필터링이 적용된 구독자 목록으로 이동
4. 브라우저에 표시되는 URL에서 'segment=' 뒤의 숫자를 확인(예: <https://stibee.com/lists/123456/subscribers/S/all/0,1,2,3/1?segment=7890> 일 때 segmentId는 'segment=' 뒤에 있는 7890)

## API 연동하기

API키를 만들고 이메일, 주소록, 그룹의 아이디를 확인하는 방법까지 알았다면 API 연동을 위한 기본적인 준비는 마무리 된 상황입니다. 지금부터는 스티비 API 문서를 참고해 원하는 기능을 구현하여 직접 사용하면 됩니다. API 문서에서는 요청에 대한 응답을 테스트 해볼 수 있고 여러 언어별 구현 예제도 확인할 수 있습니다. API를 사용해 스티비의 더 확장된 기능을 경험해보세요.

[스티비 API 문서 보러가기 →](https://developers.stibee.com)


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://help.stibee.com/api-webhook/api.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.