Integration Guide

JSON Schemas

Using the Backed.by platform is not necessary for making changes to your profile/project. Except for platform specific functions that are web2 in nature, you can make changes to your profile, create and edit tiers, and create and edit posts all using web3 tools.

The Backed.by platform uses the following JSON schemas for the documents uploaded to IPFS.

Profile

{
  "name": "Project/Profile Name",
  "description": "A catchy description of what this project is about.",
  "profileImage": "data:image/jpeg;base64,Base64 encoded image",
  "coverImage": "data:image/jpeg;base64,Base64 encoded image",
  "createdAt": Milliseconds since 1/1/1970 00:00:00
}

Tier

{
  "id": BBProfile ID,
  "name": "Tier Name",
  "price": "Price in USD cents.  $1 = 100",
  "description": "Description of what supporter gets at this tier.",
  "coverImage": "data:image/jpeg;base64,Base64 encoded image",,
  "disabled": false
}

Post (Public/Unencrypted)

{
  "content": {
    "creatorProfileId": BBProfile ID,
    "postId": BBPost ID,
    "text": "Main body of the post.  May contain HTML.",
    "attachments": [],
    "externalAttachments": []
  },
  "metadata": {
    "creatorAddress": BBProfile owner address,
    "creatorProfileId": BBProfile ID,
    "title": "Title of post",
    "createdAt": Milliseconds since 1/1/1970 00:00:00,
    "free": true
  }
}

Post (Encrypted)

{
  "content": {
    "encryptedContent": "data:application/octet-stream;base64,ENCRYPTED CONTENT",
    "litKey": LIT KEY
  },
  "metadata": {
    "creatorAddress": BBProfile owner address,
    "creatorProfileId": 4,
    "title": "Title of post",
    "createdAt": 1672972631738,
    "multipost": [],
    "free": false,
    "tierSetId": BBTiers TierSetID,
    "tierWhiteList": Array of Tier IDs this post can be seen by
  }
}