Links

White-label API

Introduction

CARV's white-label APIs allow you to seamlessly integrate powerful features of CARV onto your sites while maintaining complete control over the user experience and branding. As CARV handles all the work on the backend, various APIs are readily provided to ensure smooth integration.
Features supported include user profile display, third-party account connection, campaign display and campaign NFT minting.

Getting Started

Contact CARV team via [email protected] to get an app ID issued to your organization. All your requests to the APIs must include the following headers:
Header Name
Header Value
Example Value
x-app-id
(String) app ID
carv
authorization
(String) user authentication token
7fcbe971-3fae-5988-946b-c25afae3a9b9

API Specifications

Get user token

Pass user identities to CARV to obtain authorization token, such that 3rd platforms could invoke carv authorized APIs. Note that this API is intend to be used by client servers rather than browsers, a user's old authorization token will be invalidated after a new one is generated.
post
https://api.carv.io
/auth/token

Get user profile

Get current user's profile or another user's profile.
get
https://api.carv.io
/user/profile

List Campaigns

List campaigns in descending order by end date.
get
https://api.carv.io
/campaigns/list

Get campaign details

Get campaign details from campaign ID.
get
https://api.carv.io
/campaigns/{campaign_id}

List user mints

post
https://api.carv.io
/mints/list

Start campaign mint

post
https://api.carv.io
/mints/list