Skip to content

ton-society/sbt-platform

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

52 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

TON Society Platform

TON Society Platform aims to connect projects and users through SBT badges. The platform offers the following:

  • allows projects to issue SBT badges to their users easily and free of charge
  • helps projects attract more users
  • enables users to receive additional badges across the ecosystems, meet and compete

Learn more

Steps for direct integration

1. Register an activity

  1. Contact us to receive your project's partner_id and api_key, which provides access to the API and endpoints to issue cSTBs.
  2. Register your activity via API. Use generated activity_id in other endpoints.
  3. You could edit activity details. At the moment, SBT details cannot be changed via API. If you need to change that, please contact us directly.

2. Issuing a cSBT

Once users complete all the actions on your side you could request a unique link from our API and just lead user to this link for receiving a cSBT:

  1. Ask users to connect a wallet before they start participating in the activity. In case of Telegram Mini App, it's prefferable to use Telegram user id instead of wallet. See how to obtain it after the Mini App launch.
  2. Once users complete all the actions on your side, submit Telegram user ID or User friendly wallet address passing your activity_id. You will get the link for claiming cSBT in the response. This link is common for all the users.
  3. Share the link with the user.
  4. To get the current status of user's badge use /rewards/{participant_id}/status endpoint:
    1. NOT_CLAIMED The reward has not been claimed by the participant.
    2. CLAIMED The reward has been claimed by the participant.
    3. MINTED The reward has been minted on the TON Society side.
    4. RECEIVED The reward has been received by the participant and visible in the user profile.

3. Access cSBT and user data to display on a project side

Use TON Society APIs to display minted cSBTs and user information in your project.

Users and Collections
Provides access to publicly available information on society.ton.org regarding registered users and the SBT/cSBT collections associated with them.

cSBT data
Provides access to cSBT collections minted via TON Society in your project. This information complies with the Compressed SBT Standard.

Releases

No releases published

Packages

No packages published