사용자 중심 API

registerUser

POST https://api.pushwoosh.com/json/1.3/registerUser

외부 사용자 ID를 지정된 디바이스와 연결합니다.

요청 헤더

이름	필수	값	설명
Authorization	예	Token `XXXX`	디바이스 API에 액세스하기 위한 API 디바이스 토큰입니다. `XXXX`를 실제 디바이스 API 토큰으로 바꾸세요.

요청 본문

이름	필수	유형	설명
userId	아니요	string	디바이스와 연결할 사용자 ID입니다. 비어 있는 경우 hwid를 사용합니다.
application	예	string	Pushwoosh 애플리케이션 코드
hwid	예	string	Pushwoosh HWID
tz_offset	아니요	integer	디바이스의 시간대 오프셋(초)입니다.
device_type	아니요	integer	디바이스 유형입니다. 가능한 값은 `/registerDevice`를 참조하세요.

나중에 /createMessage API 호출(users 매개변수)에서 사용할 수 있습니다.
푸시 토큰을 받기 전과 /registerDevice를 호출하기 전에 이 함수를 호출할 수 있습니다.

요청 예시

{
  "request": {
    "userId": "user_3078a",                     // 선택 사항. 비어 있는 경우 hwid 사용
    "application": "XXXXX-XXXXX",               // 필수. Pushwoosh 애플리케이션 코드
    "hwid": "8f65b16df378e7a6bece9614e1530fb2", // 필수. 하드웨어 디바이스 ID
    "tz_offset": -3600,                         // 선택 사항. 시간대 오프셋(초)
    "device_type": 3                            // 선택 사항. 디바이스 유형, 디바이스 유형은 /registerDevice 참조
                                                //
  }
}

응답 예시

{
  "status_code": 200,
  "status_message": "OK",
  "response": null
}

deleteUser

POST https://api.pushwoosh.com/api/v2/device-api/deleteUser

애플리케이션 내에서 지정된 사용자 ID와 연결된 사용자와 모든 디바이스를 삭제합니다. 요청은 비동기적으로 처리되며, 삭제 요청이 처리되도록 수락되는 즉시 엔드포인트는 200 OK를 반환합니다.

요청 헤더

이름	필수	값	설명
Authorization	예	Token `XXXX`	디바이스 API에 액세스하기 위한 API 디바이스 토큰입니다. `XXXX`를 실제 디바이스 API 토큰으로 바꾸세요.
Content-Type	예	application/json

요청 본문

이름	필수	유형	설명
application	예	string	Pushwoosh 애플리케이션 코드
user_id	예	string	삭제할 사용자 ID입니다. 지정된 애플리케이션에서 이 사용자와 연결된 모든 디바이스가 제거됩니다.

요청 예시

{
  "application": "XXXXX-XXXXX",   // 필수. Pushwoosh 애플리케이션 코드
  "user_id": "user_3078a"         // 필수. 삭제할 사용자 ID
}

응답 예시

{
  "status_code": 200,
  "status_message": "OK",
  "response": null
}

상태 코드

HTTP 상태 코드	status_code	설명
200	200	삭제 요청 수락됨
200	210	인수 오류. 자세한 내용은 status_message를 참조하세요.
400	N/A	잘못된 형식의 요청 문자열
401	N/A	Authorization 토큰이 없거나 잘못되었습니다.
500	500	내부 오류

postEvent

POST https://api.pushwoosh.com/json/1.3/postEvent

이벤트를 트리거합니다.

요청 헤더

이름	필수	값	설명
Authorization	예	Token `XXXX`	디바이스 API에 액세스하기 위한 API 디바이스 토큰입니다. `XXXX`를 실제 디바이스 API 토큰으로 바꾸세요.

요청 본문

이름	필수	유형	설명
hwid	예	string	/registerDevice 요청에 사용된 하드웨어 디바이스 ID입니다. ‘userId’와 함께 사용하여 이벤트를 트리거한 사용자를 식별할 수 있습니다.
application	예	string	Pushwoosh 애플리케이션 코드
event	예	string	Pushwoosh Control Panel에서 생성된 것과 정확히 동일한 이벤트 이름입니다.
attributes	예	object	이벤트 속성을 포함하는 JSON 객체입니다. 전달할 속성이 없는 경우 비워 둡니다.
timestampUTC	아니요	integer	UTC의 타임스탬프입니다.
timestampCurrent	아니요	integer	현지 시간의 타임스탬프입니다.
userId	예	string	이벤트를 트리거한 사용자와 연결된 사용자 ID입니다. HWID로 대체하거나 함께 사용할 수 있습니다.
device_type	아니요	integer	가능한 값 보기

요청의 이벤트 이름은 Pushwoosh Control Panel의 이벤트 이름과 일치해야 합니다. 이벤트에 속성이 없는 경우 “attributes” 속성은 비어 있을 수 있지만(생략 불가) 생략할 수는 없습니다.

요청 예시

{
  "request":{
    "hwid": "8f65b16df378e7a6bece9614e1530fb2", // 필수. /registerDevice API에 사용된 하드웨어 디바이스 ID.
                                                //           userId와 함께 사용하여 이벤트를 트리거한 사용자를 식별할 수 있습니다.
    "application": "XXXXX-XXXXX",               // 필수. Pushwoosh 애플리케이션 코드
    "event": "activityCompleted",               // 필수. Pushwoosh Control Panel에서 생성된 것과 정확히 동일한 이벤트 이름
    "attributes": {                             // 필수. 전달할 속성이 없으면 비워 둡니다.
      "login": "facebook",
      "success": "yes",
      "internet": "wifi"
    },
    "timestampUTC": 1435228403,                 // 선택 사항. UTC의 타임스탬프
    "timestampCurrent": 1435253603,             // 선택 사항. 현지 시간의 타임스탬프
    "userId": "someuser@user.com",              // 필수. 여러 디바이스에서 사용자를 식별하는 데 사용되는 사용자 ID입니다.
                                                //           HWID로 대체하거나 함께 사용할 수 있습니다.
    "device_type": 1                            // 선택 사항.
  }
}

응답 예시

{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "code": "61BC9-84DD0"
  }
}

전환 이벤트 전송

기존 이벤트를 매핑하는 대신 수익을 직접 보고하려면, 이벤트 이름으로 PW_Conversion을 사용하고 attributes에 거래의 value와 currency를 포함하여 postEvent를 보내세요:

{
  "request":{
    "hwid": "8f65b16df378e7a6bece9614e1530fb2",
    "application": "XXXXX-XXXXX",
    "event": "PW_Conversion",
    "attributes": {
      "value": 49.99,               // 필수. 거래 금액
      "currency": "USD",            // 필수. ISO 4217 통화 코드
      "transaction_id": "txn_8f21", // 선택 사항. 자체 거래 참조
      "product_id": "prod_premium"  // 선택 사항
    },
    "userId": "someuser@user.com"
  }
}