Create a Project

To begin integrating blockchain functions into your game, you will create a project using the Playfix Project API. Projects are containers for all the token, NFT, and wallet resources you will provision for your game.

To create a project, you will make a POST request to the /project endpoint, with the relevant parameters sent as JSON in the request body.

Create a New Project

POST https://api.playfix.io/project/projects

Create a new project, which holds tokens, NFTs, and user wallets for your game.

Headers

Name	Type	Description
Authorization*	String	The access token you get from the authorization process. Example: Bearer <your_access_token>

Request Body

Name	Type	Description
title	String	The title of your project. You should use a concise, human-readable title of a few words, each separated by a space. Titles should also be unique, although this is not enforced. and duplicate project titles are allowed. Although it is optional, it is highly recommended that you use this option.
description	String	A short description of your project. Use a concise but descriptive sentence between 30 and 70 characters is recommended. Although it is optional, it is highly recommended that you use this option.
imageCoverCid	String	IPFS CID for the image to use as the project cover when it is displayed in the user interface. Although it is optional, it is highly recommended that you use this option.

200: OK Successfully created the project.

{
  "name": "projects/01g55rpe1a2kxnm1t3f90dy9ke",
  "title": "Block Party1",
  "description": "A good block party game",
  "imageCoverUrl": "https://ipfs-gateway.playfix.io/ipfs/QmSBidWX1n2ZBULNZsDKZw4QX7YFnRD1wRG4XkmLVkUypr",
  "imageCoverCid": "QmSBidWX1n2ZBULNZsDKZw4QX7YFnRD1wRG4XkmLVkUypr"
}

The example below shows how to create a new project with the title "Block Party1" and a description of "A good block party game."

Example Curl API Call

curl --request POST \
  --url https://api.playfix.io/project/projects \
  --header 'Authorization: Bearer <your_access_token>' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
    "title": "Block Party1", 
    "description": "Another good block party game", 
    "imageCoverCid": "QmSBidWX1n2ZBULNZsDKZw4QX7YFnRD1wRG4XkmLVkUypr"
    }'

Example Python API Call

import requests
import json

payload = {
    "title": "Block Party1",
    "description": "A good block party game",
    "imageCoverCid": "QmSBidWX1n2ZBULNZsDKZw4QX7YFnRD1wRG4XkmLVkUypr"
    }

r = requests.post(
    "https://api.playfix.io/project/projects",
    headers = {
        "Authorization": "Bearer <your_access_token>",
        "Accept": "application/json",
        "Content-Type": "application/json"
        },
    data = json.dumps(payload)
    )

print(r.text)

In the Authorization header, replace <your_access_token> with the token you get from the authorization process.

Response Body

{
  "name": "projects/01g55rpe1a2kxnm1t3f90dy9ke",
  "title": "Block Party1",
  "description": "A good block party game",
  "imageCoverUrl": "https://ipfs-gateway.playfix.io/ipfs/QmSBidWX1n2ZBULNZsDKZw4QX7YFnRD1wRG4XkmLVkUypr",
  "imageCoverCid": "QmSBidWX1n2ZBULNZsDKZw4QX7YFnRD1wRG4XkmLVkUypr"
}

Response Fields

• name: A unique name of the project, automatically created by Playfix. It begins with the prefix projects/ followed by the project's ULID.

• title: The title of your project, as supplied in the API request.

• description: A short description of your project, as supplied in the API request.

• imageCoverCid: The IPFS CID of the cover image to display in the user interface.

• imageCoverUrl: An automatically generated URL to an IPFS gateway that fetches the cover image.

ULID is a sortable unique identifier comprised of twenty-six Base32 encoded characters.

IPFS (Interplanetary File System) is a decentralized file system used to store content for Web3.

CID (Content Identifier) is a unique identifier that points to content on IPFS. To get this, upload your game cover image to IPFS, then copy the CID.