Pushwoosh API 개요

Pushwoosh API는 개발자가 Pushwoosh 플랫폼과 상호 작용할 수 있도록 합니다.

Pushwoosh API로 무엇을 할 수 있나요?

Pushwoosh API를 사용하면 100개 이상의 메서드로 구성된 광범위한 라이브러리에 액세스하여 다음을 수행할 수 있습니다:

개인화된 Push 알림을 전송합니다.
정확한 타겟팅을 위해 사용자 Segment를 생성, 가져오기, 내보내기 및 관리합니다.
대량 API를 활용하여 사용자/디바이스를 일괄적으로 관리합니다.
Application을 구성합니다.
사용자 Event를 추적하고 사용자에게 Tag를 추가하여 타겟팅 및 개인화를 강화합니다.
Preset, Tag, Event, Application 등과 같은 Pushwoosh Entity를 생성하고 관리합니다.
API를 통해 Pushwoosh Customer Journey를 시작합니다.
Customer Journey 및 Push/Email/SMS Campaign에 대한 포괄적인 통계를 검색합니다.
Geofencing을 구현하여 사용자가 특정 지리적 영역에 진입하거나 이탈할 때 위치 기반 알림을 전송합니다.
Pushwoosh와 3rd party 서비스를 원활하게 통합합니다.

사용 가능한 모든 메서드를 탐색하고 Pushwoosh API의 광범위한 기능을 알아보려면 API 메서드 참조 색인을 참조하십시오.

인증

Pushwoosh API는 API 토큰을 사용하여 요청을 인증합니다. 두 가지 유형의 토큰이 있습니다: Server 및 Device이며, 각 토큰은 특정 API 범위에 사용됩니다.

각 Pushwoosh 계정에는 Pushwoosh Demo App용으로 생성된 기본 API Access Token이 제공됩니다. Pushwoosh Control Panel에서 API 토큰을 보고, 생성하고, 관리할 수 있습니다.

더 알아보기

Rate 제한

Rate 제한은 API가 주어진 기간 내에 수신할 수 있는 요청 수입니다. Pushwoosh의 대부분의 API 요청은 제한되지 않지만, 모든 사용자를 위한 서비스 품질을 보장하기 위해 /createMessage API 요청은 분당 600개로 제한됩니다.

요청

모든 API 요청에는 안전한 데이터 전송을 보장하기 위해 HTTPS가 필수입니다.

응답

Pushwoosh API는 일반적으로 JSON 응답을 반환합니다.

성공 및 오류 코드

성공 코드

API 요청이 성공적으로 처리되면 응답의 일부로 성공 코드를 받게 됩니다.

HTTP status code	Status message	Description
200	OK	Pushwoosh가 요청을 성공적으로 처리했습니다.

HTTP 200 응답을 받았을 때, 이는 요청이 이해되고 성공적으로 처리되었음을 의미하지만, 작업의 성공을 보장하지는 않습니다. 따라서 작업의 성공 여부를 확인하려면 오류 또는 경고 메시지(액세스 거부됨, Application을 찾을 수 없음, 유효하지 않은 API 키 등)를 확인해야 합니다.

Status code	Status message
200	경고: 구독자 한도에 도달했습니다. Push Message는 1개의 임의 Device로만 전송됩니다.
200	경고: 현재 구독 플랜에서 허용되는 활성 Device 수를 초과했습니다.
210	액세스 거부됨 또는 Application을 찾을 수 없음
210	Application을 찾을 수 없음
210	Application이 일시 중단되었습니다.
210	계정을 찾을 수 없음
210	계정이 일시 중단되었습니다.
210	일시 중단된 계정은 Device 필터링을 사용할 수 없습니다.
210	API 토큰 또는 Application이 설정되지 않았습니다.
210	하나 이상의 Platform을 선택하십시오.
210	유효하지 않은 API Token: 계정을 찾을 수 없음
210	Application 또는 그룹 코드가 제공되지 않았습니다.
210	API 토큰 또는 Application 또는 계정이 설정되지 않았습니다.

오류 코드

요청 형식이 올바르지 않거나, 처리 문제가 발생하거나, 기타 오류가 발생하는 경우, Pushwoosh는 문제의 성격을 나타내는 오류 코드를 전송하여 문제를 효과적으로 해결하고 처리하는 데 도움을 줍니다.

HTTP status code	Status message	Description
400	잘못된 요청	잘못된 구문으로 인해 요청을 처리할 수 없습니다.
401	권한 없음	인증에 실패했거나 제공되지 않았습니다.
403	토큰 제한으로 인해 이 작업을 수행할 수 없습니다.	액세스 토큰에 요청된 작업을 수행하는 데 필요한 권한이 없습니다. 이 문제를 해결하려면 Pushwoosh Control Panel에서 액세스 토큰의 권한을 검토하고 수행하려는 특정 작업의 요구 사항과 일치하도록 필요에 따라 조정하십시오.
404	리소스를 찾을 수 없음	Application과 같이 요청된 리소스를 찾을 수 없거나 서버에 존재하지 않음을 나타냅니다.
500	내부 오류	API 요청 처리 중 서버에서 예기치 않은 문제 또는 오류가 발생했습니다.