Quick Start

To register, manage, and test purchases with no code for ClickCrate POS and Product Listings request early access to our Seller Dashboard: [email protected]

1. Get an API key

Your API requests are authenticated using API keys. Any request that doesn't include an API key will return an error.

To request an API key send us an email: [email protected]

2. Register a ClickCrate POS

Register a point of sale in the decentralized registry.

Register a new ClickCrate

post

https://api.clickcrate.xyzhttp://localhost:8080

/v1/clickcrate/register

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

authorizationstringRequiredExample: Bearer <YOUR_API_KEY>

Body

application/json

clickcrateIdstringRequiredPattern: ^[1-9A-HJ-NP-Za-km-z]{32,44}$

eligiblePlacementTypestring · enumRequiredPossible values:

eligibleProductCategorystring · enumRequiredPossible values:

managerstringRequiredPattern: ^[1-9A-HJ-NP-Za-km-z]{32,44}$

Responses

200

200

application/json

messagestringRequired

transactionstringRequired

400

400

application/json

409

409

application/json

post

/v1/clickcrate/register

HTTPcURLJavaScriptPython

POST /v1/clickcrate/register HTTP/1.1
Host: api.clickcrate.xyz
Authorization: Bearer YOUR_SECRET_TOKEN
authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 118

{
  "clickcrateId": "text",
  "eligiblePlacementType": "digitalreplica",
  "eligibleProductCategory": "clothing",
  "manager": "text"
}

{
  "message": "text",
  "transaction": "text"
}

3. Activate your ClickCrate POS

Activate your ClickCrate to make it available for product placements.

Activate a ClickCrate

post

https://api.clickcrate.xyzhttp://localhost:8080

/v1/clickcrate/activate

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

authorizationstringRequiredExample: Bearer <YOUR_API_KEY>

Body

application/json

clickcrateIdstringRequiredPattern: ^[1-9A-HJ-NP-Za-km-z]{32,44}$

Responses

200

200

application/json

messagestringRequired

transactionstringRequired

404

404

application/json

post

/v1/clickcrate/activate

HTTPcURLJavaScriptPython

POST /v1/clickcrate/activate HTTP/1.1
Host: api.clickcrate.xyz
Authorization: Bearer YOUR_SECRET_TOKEN
authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 23

{
  "clickcrateId": "text"
}

{
  "message": "text",
  "transaction": "text"
}

4. Register a Product Listing

Register a product listing in the decentralized registry.

Register a new ProductListing

post

https://api.clickcrate.xyzhttp://localhost:8080

/v1/product-listing/register

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

authorizationstringRequiredExample: Bearer <YOUR_API_KEY>

Body

application/json

productListingIdstringRequiredPattern: ^[1-9A-HJ-NP-Za-km-z]{32,44}$

originstring · enumRequiredPossible values:

placementTypestring · enumRequiredPossible values:

productCategorystring · enumRequiredPossible values:

managerstringRequiredPattern: ^[1-9A-HJ-NP-Za-km-z]{32,44}$

priceintegerRequired

orderManagerstring · enumRequiredPossible values:

Responses

200

200

application/json

messagestringRequired

transactionstringRequired

400

400

application/json

409

409

application/json

post

/v1/product-listing/register

HTTPcURLJavaScriptPython

POST /v1/product-listing/register HTTP/1.1
Host: api.clickcrate.xyz
Authorization: Bearer YOUR_SECRET_TOKEN
authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 166

{
  "productListingId": "text",
  "origin": "clickcrate",
  "placementType": "digitalreplica",
  "productCategory": "clothing",
  "manager": "text",
  "price": 1,
  "orderManager": "clickcrate"
}

{
  "message": "text",
  "transaction": "text"
}

5. Activate your Product

Activate your Product Listing to make it available for placement into a ClickCrate POS.

Activate a ProductListing

post

https://api.clickcrate.xyzhttp://localhost:8080

/v1/product-listing/activate

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

authorizationstringRequiredExample: Bearer <YOUR_API_KEY>

Body

application/json

productListingIdstringRequiredPattern: ^[1-9A-HJ-NP-Za-km-z]{32,44}$

Responses

200

200

application/json

messagestringRequired

transactionstringRequired

404

404

application/json

post

/v1/product-listing/activate

HTTPcURLJavaScriptPython

POST /v1/product-listing/activate HTTP/1.1
Host: api.clickcrate.xyz
Authorization: Bearer YOUR_SECRET_TOKEN
authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 27

{
  "productListingId": "text"
}

{
  "message": "text",
  "transaction": "text"
}

6. Place your Product

Place your product into your ClickCrate POS to make it available for sale in that ClickCrate.

Place a ProductListing in a ClickCrate

post

https://api.clickcrate.xyzhttp://localhost:8080

/v1/product-listing/place

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

authorizationstringRequiredExample: Bearer <YOUR_API_KEY>

Body

application/json

productListingIdstringRequiredPattern: ^[1-9A-HJ-NP-Za-km-z]{32,44}$

clickcrateIdstringRequiredPattern: ^[1-9A-HJ-NP-Za-km-z]{32,44}$

pricenumberRequired

Responses

200

200

application/json

messagestringRequired

transactionsstring[]Required

400

400

application/json

post

/v1/product-listing/place

HTTPcURLJavaScriptPython

POST /v1/product-listing/place HTTP/1.1
Host: api.clickcrate.xyz
Authorization: Bearer YOUR_SECRET_TOKEN
authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 59

{
  "productListingId": "text",
  "clickcrateId": "text",
  "price": 1
}

{
  "message": "text",
  "transactions": [
    "text"
  ]
}

7. Make a purchase

Purchase the placed product from your ClickCrate POS.

Make a purchase using a ClickCrate

post

https://api.clickcrate.xyzhttp://localhost:8080

/v1/clickcrate/purchase

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

authorizationstringRequiredExample: Bearer <YOUR_API_KEY>

Body

application/json

productListingIdstringRequiredPattern: ^[1-9A-HJ-NP-Za-km-z]{32,44}$

productIdstringRequiredPattern: ^[1-9A-HJ-NP-Za-km-z]{32,44}$

clickcrateIdstringRequiredPattern: ^[1-9A-HJ-NP-Za-km-z]{32,44}$

sizestring · nullableOptional

quantityintegerRequired

buyerstringRequiredPattern: ^[1-9A-HJ-NP-Za-km-z]{32,44}$

payerstringRequiredPattern: ^[1-9A-HJ-NP-Za-km-z]{32,44}$

paymentProcessorstring · enumRequiredPossible values:

Responses

200

200

application/json

messagestringRequired

transactionstringRequired

400

400

application/json

401

401

application/json

402

402

application/json

post

/v1/clickcrate/purchase

HTTPcURLJavaScriptPython

POST /v1/clickcrate/purchase HTTP/1.1
Host: api.clickcrate.xyz
Authorization: Bearer YOUR_SECRET_TOKEN
authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 153

{
  "productListingId": "text",
  "productId": "text",
  "clickcrateId": "text",
  "size": "text",
  "quantity": 1,
  "buyer": "text",
  "payer": "text",
  "paymentProcessor": "solana"
}

{
  "message": "text",
  "transaction": "text"
}

Congratulations you've successfully integrated ClickCrate and completed your first purchase!! 🎉 🎉 🎉

Want to integrate further?

Product ListingPoint of Sale (ClickCrate)