> For the complete documentation index, see [llms.txt](https://docs.dfinery.ai/api-guide/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.dfinery.ai/api-guide/readme.md).

# 시작하기

DFINERY의 API를 통해 온/오프라인 유저의 이벤트 및 속성을 전송하고, 데이터를 추출할 수 있습니다.

## 시작하기 전에

DFINERY의 API를 사용하기 전에, 아래 사항이 사전에 준비되어 있어야 합니다.

1. **회원가입 및 조직, 서비스 생성** : API를 사용하기 위해서는 회원가입 후, 조직과 서비스가 생성되어 있어야 합니다. 자세한 사항은 이용자 가이드의 [디파이너리 시작하기](https://github.com/IGAWorksDev/dfn-v2-developer-reference-gitbook/blob/main/api_guide/ko/broken-reference/README.md)를 참고하시면 됩니다.
2. **이벤트 및 유저 속성 등록** : DFINERY는 사전 등록된 이벤트와 유저 속성 데이터만을 적재합니다. 적재하고자 하는 이벤트와 유저 속성 데이터가 있다면 미리 콘솔에서 등록하여야 합니다. 자세한 사항은 이용자 가이드의 [디파이너리 시작하기](https://github.com/IGAWorksDev/dfn-v2-developer-reference-gitbook/blob/main/api_guide/ko/broken-reference/README.md)를 참고하시면 됩니다.
3. **API 토큰 발급** : DFINERY는 API 토큰을 통해 사용자가 보낸 요청이 인증된 요청인지 판단합니다. API 토큰은 디파이너리 콘솔을 통해 발급 받을 수 있습니다. 자세한 사항은 [인증](/api-guide/authentication.md)을 참고하시면 됩니다.
4. **API 요청 제한 고려** : DFINERY는 서비스별로 시간당 API 호출 횟수를 제한합니다. API 요청 시에는 API 요청 제한을 고려하여 요청하도록 설계해야 합니다. 자세한 사항은 [요청 제한](/api-guide/rate-limit.md)을 참고하시면 됩니다.

## API

### 도메인

DFINERY API는 아래 한개의 도메인을 사용합니다.

| URL                          | 설명              |
| ---------------------------- | --------------- |
| <https://openapi.dfinery.ai> | DFINERY API 도메인 |

### API 컬렉션

DFINERY는 아래와 같은 종류의 API를 제공합니다.

| 분류                                                    | 설명                                             |
| ----------------------------------------------------- | ---------------------------------------------- |
| [Event](/api-guide/api/import-api/event-api.md)       | 유저의 이벤트 데이터를 적재할 수 있습니다.                       |
| [Identity](/api-guide/api/import-api/identity-api.md) | 유저 식별정보를 업데이트합니다. 이를 통해 유저를 식별하고, 통합할 수 있습니다.  |
| [Profile](/api-guide/api/import-api/profile.md)       | 유저의 속성을 업데이트 할 수 있습니다.                         |
| [Export](/api-guide/api/export-api/export.md)         | DFINERY에 적재되어 있는 유저의 이벤트 및 행동 데이터를 추출할 수 있습니다. |

## 데이터 타입

DFINERY API에서는 일관된 데이터 타입과 포맷을 사용합니다. 사용자가 API를 연동할 때에는 API에서 요구하는 데이터 타입에 맞춰 요청하여야 합니다.

자세한 사항은 [데이터 타입](/api-guide/data-type.md)을 참고하시면 됩니다.

## 인증

DFINERY는 API 토큰을 통해 사용자가 보낸 요청이 인증된 요청인지 판단합니다. 모든 API 요청의 헤더에는 API 토큰이 필수로 포함되어야 합니다. API 토큰은 디파이너리 콘솔을 통해 발급 받을 수 있습니다.

DFINERY의 API 토큰은 Import API, Export API 토큰으로 나뉘어 있습니다. Import API 토큰은 디파이너리에 고객사의 데이터를 전송할 때 사용합니다 (Event, Identity, Profile API). Export API 토큰은 고객사가 디파이너리에 적재되어 있는 데이터를 추출할 때 사용합니다 (Export API).

자세한 사항은 [인증](/api-guide/authentication.md)을 참고하시면 됩니다.

#### Import API 토큰

```
access_token: ${your-import-api-token}
```

#### Export API 토큰

```
Authorization: Bearer ${your-export-api-token}
```

## 요청 제한

DFINERY는 안정적인 서비스 운영을 위해 서비스별로 시간당 API 요청 횟수를 제한합니다. API 요청 제한을 초과하면 이후의 모든 요청은 실패하고, 제한 시간이 지나 요청 제한이 초기화된 후 요청이 성공합니다. API 요청 제한에 대한 자세한 내용은 [요청 제한](/api-guide/rate-limit.md)을 참고하시면 됩니다.