Pushwoosh API 개요
Pushwoosh API를 사용하면 개발자가 Pushwoosh 플랫폼과 상호 작용할 수 있습니다.
Pushwoosh API로 무엇을 할 수 있나요?
Anchor link toPushwoosh API를 사용하면 100개 이상의 메서드로 구성된 광범위한 라이브러리에 액세스하여 다음을 수행할 수 있습니다:
- 개인화된 푸시 알림 전송
- 정확한 타겟팅을 위한 사용자 세그먼트 생성, 가져오기, 내보내기 및 관리
- 대량 API를 활용하여 사용자/기기를 일괄적으로 관리
- 애플리케이션 구성
- 사용자 이벤트를 추적하고 사용자에게 태그를 추가하여 타겟팅 및 개인화 강화
- 프리셋, 태그, 이벤트, 애플리케이션 등과 같은 Pushwoosh 엔티티 생성 및 관리
- API를 통해 Pushwoosh Customer Journey 시작
- Customer Journey 및 푸시/이메일/SMS 캠페인에 대한 포괄적인 통계 검색
- 지오펜싱을 구현하여 사용자가 특정 지리적 영역에 들어가거나 나갈 때 위치 기반 알림 전송
- 타사 서비스를 Pushwoosh와 원활하게 통합
사용 가능한 모든 메서드를 살펴보고 Pushwoosh API의 광범위한 기능을 알아보려면 API 메서드 참조 인덱스를 참조하세요.
Pushwoosh API는 API 토큰을 사용하여 요청을 인증합니다. 토큰에는 서버와 기기의 두 가지 유형이 있으며, 각각 특정 API 범위에 사용됩니다.
각 Pushwoosh 계정에는 Pushwoosh 데모 앱용으로 생성된 기본 API 액세스 토큰이 함께 제공됩니다. Pushwoosh 제어판에서 API 토큰을 보고, 생성하고, 관리할 수 있습니다.
속도 제한
Anchor link to속도 제한은 API가 주어진 기간 내에 수신할 수 있는 요청의 수입니다. Pushwoosh의 대부분의 API 요청은 제한이 없지만, /createMessage 및 이에 상응하는 Messaging API v2 Notify 요청은 모든 사용자에게 서비스 품질을 보장하기 위해 분당 600개로 제한됩니다.
안전한 데이터 전송을 보장하기 위해 모든 API 요청에 HTTPS가 필수입니다.
Pushwoosh API는 일반적으로 JSON 응답을 반환합니다.
성공 및 오류 코드
Anchor link to성공 코드
Anchor link toAPI 요청이 성공적으로 처리되면 응답의 일부로 성공 코드를 받게 됩니다.
| HTTP 상태 코드 | 상태 메시지 | 설명 |
|---|---|---|
| 200 | OK | Pushwoosh가 요청을 성공적으로 처리했습니다 |
HTTP 200 응답을 받았다는 것은 요청이 이해되고 성공적으로 처리되었음을 의미하지만, 작업의 성공을 보장하지는 않습니다. 따라서 작업의 성공 여부를 확인하려면 오류 또는 경고 메시지(액세스 거부, 애플리케이션을 찾을 수 없음, 잘못된 API 키 등)를 확인해야 합니다.
| 상태 코드 | 상태 메시지 |
|---|---|
| 200 | 경고: 구독자 한도에 도달했습니다. 푸시 메시지는 임의의 기기 1대에만 전송됩니다 |
| 200 | 경고: 현재 구독 요금제에서 허용된 활성 기기 수를 초과했습니다. |
| 210 | 액세스 거부 또는 애플리케이션을 찾을 수 없음 |
| 210 | 애플리케이션을 찾을 수 없음 |
| 210 | 애플리케이션이 일시 중단됨 |
| 210 | 계정을 찾을 수 없음 |
| 210 | 계정이 일시 중단됨 |
| 210 | 일시 중단된 계정은 기기 필터링을 사용할 수 없음 |
| 210 | API 토큰 또는 애플리케이션이 설정되지 않음 |
| 210 | 하나 이상의 플랫폼을 선택하세요 |
| 210 | 잘못된 API 토큰: 계정을 찾을 수 없음 |
| 210 | 애플리케이션 또는 그룹 코드가 제공되지 않음 |
| 210 | API 토큰 또는 애플리케이션 또는 계정이 설정되지 않음 |
오류 코드
Anchor link to요청 형식이 올바르지 않거나, 처리 문제가 발생하거나, 다른 오류가 발생하는 경우 Pushwoosh는 문제의 성격을 나타내는 오류 코드를 전송하여 문제 해결 및 효과적인 해결을 돕습니다.
| HTTP 상태 코드 | 상태 메시지 | 설명 |
|---|---|---|
| 400 | 잘못된 요청 | 구문이 잘못되어 요청을 처리할 수 없습니다 |
| 401 | 권한 없음 | 인증에 실패했거나 제공되지 않았습니다 |
| 403 | 토큰 제한으로 인해 이 작업이 금지되었습니다. | 액세스 토큰에 요청된 작업을 수행하는 데 필요한 권한이 없습니다. 이 문제를 해결하려면 Pushwoosh 제어판에서 액세스 토큰의 권한을 검토하고 수행하려는 특정 작업의 요구 사항에 맞게 필요에 따라 조정하세요. |
| 404 | 리소스를 찾을 수 없음 | 앱과 같이 요청된 리소스를 찾을 수 없거나 서버에 존재하지 않음을 나타냅니다. |
| 500 | 내부 오류 | API 요청을 처리하는 동안 서버에서 예기치 않은 문제나 오류가 발생했습니다. |