[Gametize Tech] API: Packages Level Functions Summary

In Gametize, package are currently the highest level in our project structure. 

Structure overview:

Package > Project > Topic > Challenge;

Package contain Projects;
Projects contain Topics;
Topics contain Challenge;

Below are a list of API that is available for package level usage.

Retrieval API

Featured Projects: /api2/packages/ID/projects.json

• Public API

• Security:

  • Private projects are hidden based on API session

Store Rewards: /api2/packages/ID/rewards.json

• Private API (API Session is required)

• API 2.0 Only

• Package-level store mode must be enabled

• Security:

  • Rewards belonging to private projects are hidden based on API session

Leaderboard: /api2/packages/ID/leaderboard.json

• Private API (API Session is required)

• API 2.0 Only

• Security:

  • Apart from being a private API, users shown may belong to private projects only

• Limitation:

  • Team mode is not supported as team is a project-level data and cannot be consolidated on package-level

  • Non-indexed type is not supported - Only the following type is supported: overall, quarterly, monthly, daily

Leaderboard Overview: /api2/packages/ID/leaderboard_overview.json

• Private API (API Session is required)

• API 2.0 Only

• Security:

  • Apart from being a private API, users shown may belong to private projects only

• Limitation:

  • Team mode is not supported as team is a project-level data and cannot be consolidated on package-level

  • Non-indexed type is not supported - Only the following type is supported: overall, quarterly, monthly, daily

Player Widget: /api2/users/ID/widget.json?package_id=[PACKAGE ID]

• Private API (API Session is required)

• Security:

  • Limited to viewing own-data only

• Limitation:

  • Team information is not included as team is a project-level data and cannot be consolidated on package-level

Joined Projects: /api2/users/ID/projects.json?package_id=[PACKAGE ID]

• Private API (API Session is required)

• Security:

  • Limited to viewing own-data only

Achievements Earned: /api2/users/ID/achievements.json?package_id=[PACKAGE ID]

• Private API (API Session is required)

• Security:

  • Limited to viewing own-data only

• Limitation:

  • Team achievements are not included as team is a project-level data and cannot be consolidated on package-level

Rewards Redemption: /api2/users/ID/redemption.json?package_id=[PACKAGE ID]

• Private API (API Session is required)

• API 2.0 Only

• Package-level store mode must be enabled

• Security:

  • Limited to viewing own-data only

Notifications: /api2/notifications.json?package_id=[PACKAGE ID]

• Private API (API Session is required)

• API 2.0 Only

• Security:

  • Limited to viewing own-data only

Notifications Unread: /api2/notifications/unread.json?package_id=[PACKAGE ID]

• Private API (API Session is required)

• API 2.0 Only

• Security:

  • Limited to viewing own-data only

Action API

Redeem Rewards: /api2/action/redeem_reward.json - Body: package_id=[PACKAGE ID]

• Private API (API Session is required)

• API 2.0 Only

• Package-level store mode must be enabled

• Security:

  • Limited to redeeming reward belonging to accessible projects

Note:

The article's technical specifications and details are subject to potential changes based on our discretion. It is important to note that the information presented in the article might have become outdated or lost its relevance in the present context.

If you are interested to learn more about this, please drop an email to support@gametize.com with your queries regarding the article!