Service access control
'Service access control' is a Hive Axyl SDK feature that returns the results needed for access restrictions or notices based on the user's country code, the server maintenance status, and the app client version. According to these results, the app implements access blocking, notice screen display, and redirects.
Features
Hive Axyl provides service country restriction, server maintenance, and client update features. You check each of the three features with a separate method, and the app decides which features to call and in what order.
| Feature | Basis for controlling user access to the app | What the app client handles |
|---|---|---|
| Service country restriction | The user country code that the app passes and the list of blocked countries registered in the console | Blocking user entry by country or displaying an access notice screen |
| Server maintenance | Maintenance settings such as the server maintenance schedule, and the current time | Restricting access or displaying a maintenance notice screen |
| Client update | The current app client version and the target update version registered in the console | Forcing an app client update or encouraging an optional update |
-
Service country restriction
Service country restriction checks whether the user country code that the app passes for a specific App ID matches a blocked country and returns the result. If the user is blocked, it also returns the list of blocked countries specified for that App ID in the applied service country restriction item. The app client must decide for itself, according to this result, whether to allow the user to access the app and how to display the notice screen.
-
Server maintenance
Server maintenance returns the active server maintenance items based on the current time, including the maintenance start and end times, the list of servers under maintenance, and the list of versions under maintenance. If you specify a server ID in the request, only the maintenance that applies to that server is returned. If you specify an app version, the maintenance registered for that version is also returned.
-
Client update
Client update returns whether the current app client version needs an update and whether the update is forced or optional. If an update is needed, the response also contains the target app version.
Notice messages and effective periods
Service country restriction, server maintenance, and client update all return the notice title, body, and notice URL registered in the console. Notice messages are delivered in the language that the app requested; if no message is registered in that language, the message in the default language is delivered. Items with a specified effective period also return the start and end times and the reference time zone information used to interpret those times.