Authentication
Push system API¶
Push system sends pushes by using APIs. The system utilizes push services such as APNS, FCM, and ADM from each market. Following image describes how request data is transmitted to the service.
Note
- APNS (Apple Push Notification Service): Push service with Apple
(https://developers.apple.com/go/?id=push-notifications)
- FCM (Firebase Cloud Messaging): Push service with Google
(https://firebase.google.com/docs/cloud-messaging)
- ADM (Amazon Device Messaging): Push service with Amazon
Push system manages to search suitable token data for payload composition, and transfers the data to each service. Sending push messages to devices is what each service does. In brief, Push system just traces whether the calling process of the service is succeeded, and analyzing the cause of unreceived device is not supported.
Tip
APNS provides dedicated endpoints for each app build and distribution environment (production and sandbox).
- Production: api.push.apple.com
- Sandbox: api.sandbox.push.apple.com
Device tokens issued in APNS production or sandbox environments are only valid for the corresponding endpoint and cannot be used in other environments. For more details, refer to the official Apple documentation.
The Hive push system uses either the sandbox or production endpoint based on the service type of the registered AppID.
- If the service type is 'TEST' → uses the sandbox endpoint
- If the service type is not 'TEST' → uses the production endpoint
Warning
The Hive push system cannot use both the 'production' and 'sandbox' endpoints provided by APNS at the same time; only one endpoint is supported.
If you arbitrarily change the service type of the registered AppID, you may request an invalid endpoint. Make sure to set the service type according to your operating environment. For more details, refer to AppID management.
URL¶
| Server | URL |
|---|---|
| Production | https://notification.withhive.com |
| Sandbox | https://sandbox-notification.withhive.com |
Authentication¶
To implement the API which Push system provides, authorization token (API KEY) is required. Authorization token, which follows JWT (JSON Web Token: https://jwt.io) specification, doesn't limit the expiry time, so it is available to keep using this token. After registering the game in AppCenter, authorization token is automatically created. Go to the Operation > AppCenter > Game Management > 1. Basic Information for details.