Tutorial Endpoints
Description of endpoints used to get data related to tutorials on the DeSo blockchain
Last updated
Description of endpoints used to get data related to tutorials on the DeSo blockchain
Last updated
Please make sure you've read Data: API so you are familiar with the following types referenced in this documentation:
POST POST /api/v0/get-tutorial-creators
Get the well-known and up-and-coming creators featured in the Buy a Creator step of the tutorial. Creators who have a founder's reward greater than 10% are excluded here.
Endpoint implementation in backend.
Example usage in frontend: - Make request to Get Tutorial Creators - Use GetTutorialCreators to display creators to the user when they are prompted to buy well-known or up-and-coming creators in the tutorial
| Name | Type | Description |
|---|---|---|
POST /api/v0/start-or-skip-tutorial
Begin or skip the tutorial.
Endpoint implementation in backend.
Example usages in frontend: - Make request to Start Or Skip Tutorial - Use StartOrSkipTutorial to send user into tutorial or skip
No response body
POST /api/v0/update-tutorial-status
Override endpoint to automatically update a user's tutorial status
Valid values for tutorial status are TutorialStarted, TutorialSkipped, InvestInOthersBuyComplete, InvestInOthersSellComplete, TutorialCreateProfileComplete, InvestInYourselfComplete, FollowCreatorsComplete, GiveADiamondComplete, TutorialComplete
Endpoint implementation in backend.
Example usages in diamondapp.com's frontend: - Make request to Update Tutorial Status - Use UpdateTutorialStatus to set the user's tutorial status to the current step in your tutorial
No response body.
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
PublicKeyBase58Check*
string
Public key of user starting or skipping tutorial
JWT*
string
JSON web token authenticating user
IsSkip
boolean
if true, update the user's tutorial status to skipped. Otherwise, set the tutorial status to started
PublicKeyBase58Check*
string
Public key of user whose tutorial status is being updated
JWT*
string
JSON web token authenticating user
TutorialStatus*
string
Value to be set for user's Tutorial status.
CreatorPurchasedInTutorialPublicKey
string
Public key of creator the well-known or up-and-coming the user purchased in the tutorial
ClearCreatorCoinPurchasedInTutorial
boolean
If true, sets the user's CreatorCoinsPurchasedInTutorial to 0
ResponseLimit*
int
Number of creators to return for each category