Describes how to generate an url to a creators’ website, email or social media accounts based on base_url, value, and type.
Property |
Type |
Description |
---|---|---|
type | LinkType | The website |
value | String | The specific path to append to the website to get to a creator’s profile |
base_url | String (Optional, usually ignored) | Base url for the link. For security reasons this value is usually ignored by clients to avoid the following scenario: Setting a link type as TWITTER but linking to a malicious site that isn't twitter.com. Click here for a list of assumed base_urls based on type. |
Possible website to use as a creators’ website, email or social media accounts
enum LinkType {
INSTAGRAM
YOUTUBE
TIKTOK
PATREON
KO_FI
EMAIL
TWITTER
MASTODON
FACEBOOK
WEBSITE # can be any website that starts with https://
MERCH_STORE # can be any website that starts with https://
LINKTREE
TWITCH
SNAPCHAT
REDDIT
DISCORD
TELEGRAM
ETSY
PINTEREST
TUMBLR
SPOTIFY
SOUNDCLOUD
BANDCAMP
VIMEO
WECHAT
WHATSAPP
}
For the following links, let get the link to the creator’s twitter account:
We take the link with type = TWITTER, and append our assumed base_url + value.
Result: https://twitter.com/dmathewwws
links": [
{
"type": "TWITTER",
"base_url": "<https://twitter.com/>",
"value": "dmathewwws"
},
{
"type": "EMAIL",
"value": "[email protected]"
},
{
"type": "WEBSITE",
"base_url": "https://",
"value": "bamcomics.art"
}
],