User invitation is a feature that allows a user to issue an invitation code to invite other users to the game and receive rewards from the developer for doing so. The user invitation API is an API that allows the game to issue invitation codes and match users who have accepted the invitation.
Warning
The Authorization Header is not mandatory for all APIs below. However, for security reasons, it is recommended to use the Hive authentication key and call the API directly from the game server.
To use the invitation code-related API, you need to prepare the following items.
Hive authentication key to be used in the Authorization Header: Hive Console > App Center > Project Management > Select App after searching for the app > Game Details > Basic Information > Hive Authentication Key
server_id: Hive Console > App Center > Project Management > Select App after searching for the app > Game Details > Game Server
Invitation Campaign: Issue invitation code type by registering create campaign in Hive Console > Promotion > User Invitation > Invitation Campaign Registration
Retrieving invitation campaign information created in the Hive console. Only active and available invitation campaign information will be fetched. The reward information set for the campaign will also be included in the response.
{"campaign_list":[{"id":"19","title":"초대 코드 발급_행동_설치(초대 2, 수락 3, 제한 2)","rewards":[{"reward_id":33,"description":"행동_설치(초대 2, 수락 3, 제한 2)","reward_type":"action","action_type":"cpi","cpa_code":null,"goal":1,"limit":2}]}],"result_code":200,"result_message":"Success"}
Users can receive invitation codes in the campaign. Each campaign can issue only one invitation code. To reward the inviter, the server ID that the inviter accessed must be provided.
Enter the invitation code to match the inviter and the recipient. To prevent reward abuse, it is recommended to verify the acceptor's account information on the game server before making the matching request. Matching rewards are given only once per campaign.