📔Open API Specification

Context

Here you will find our OpenAPI specification for the Chainvine API.

All endpoints below require you to provide your api key in the headers

{
    'X-API-KEY': 'your-api-key'
}

SyncUser

Always call this method early on in your flows to fetch a user's Chainvine ID.

Note: the SDK handles calling this endpoint for your when using the SDK to call the methods in the ChainvineUser section.

Creates or updates a user, and returns the user's details. Use this method to get your user's Chainvine ID to use the methods bellow.

POSThttps://api.chainvine.xyz/api/v2/users

Body

application/json

chain_idstring

emailstring

external_idstring

firstNamestring

lastNamestring

networkstring

wallet_addressstring

user_type*string

Pattern: ^(wallet|email|externalId)

Response

200400500

User created successfully

Body

application/json

idstring

Request

JavaScriptCurlPython

const response = await fetch('https://api.chainvine.xyz/api/v2/users', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "user_type": "wallet"
    }),
});
const data = await response.json();

Response

200

{
  "id": "text"
}

This endpoint can also be used to update the user's information.

ChainvineUser

These endpoints can also be covered via the SDK. Please see methods outlined there as needed or examples of how to use these endpoints to suit your needs.

Create a referral between a referrer and claimer

Create a referral between a referrer and a claimer

POSThttps://api.chainvine.xyz/api/v2/user/{user_id}/campaign/{campaign_id}/link/referral

Path parameters

user_id*string

campaign_id*string

The campaign id you want to create a referral in

Body

application/json

campaign_id*string (slug)

The campaign id you want to create a referral in

Example: "joidj2odkd"

referrer*string (uuid)

The referring user's Chainvine Id, obtained via the referral link r parameter

Example: "fjdopwdp2pmosjo2ds"

wallet_address*string

Example: "0x03jkd0ij2od"

Response

200400

OK

Request

JavaScriptCurlPython

const response = await fetch('https://api.chainvine.xyz/api/v2/user/{user_id}/campaign/{campaign_id}/link/referral', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "referrer": "fjdopwdp2pmosjo2ds",
      "wallet_address": "0x03jkd0ij2od",
      "campaign_id": "joidj2odkd"
    }),
});
const data = await response.json();

Get the referral url for your user

Generates your user's referral url for the program id provided

GEThttps://api.chainvine.xyz/api/v2/user/{user_id}/campaign/{campaign_id}/referral/url

Path parameters

user_id*string

campaign_id*string

The campaign id you want to generate a referral url for

Response

200400

OK

Request

JavaScriptCurlPython

const response = await fetch('https://api.chainvine.xyz/api/v2/user/{user_id}/campaign/{campaign_id}/referral/url', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Handle a transfer event

Send a custom transfer event with a monetary payload to apply to credit as a reward to the referrer who referrer the user

POSThttps://api.chainvine.xyz/api/v2/user/{user_id}/campaign/{campaign_id}/events/transfer

Path parameters

user_id*string

campaign_id*string

The campaign id you want to generate a transfer event in

Body

application/json

amount*number

Example: 12443.43

requirement_idstring

Example: "anId123"

external_identifierstring

Example: "Ok"

feenumber

Example: 134.32

token_addressstring

Example: "Ok"

transaction_hashstring

Example: "Ok"

usd_valuenumber

Example: 134.32

user_idstring

Example: "Ok"

wallet_addressstring

Example: "Ok"

Response

200400

Event handled successfully

Body

application/json

amount*number

Example: 12443.43

requirement_idstring

Example: "anId123"

external_identifierstring

Example: "Ok"

feenumber

Example: 134.32

token_addressstring

Example: "Ok"

transaction_hashstring

Example: "Ok"

usd_valuenumber

Example: 134.32

user_idstring

Example: "Ok"

wallet_addressstring

Example: "Ok"

Request

JavaScriptCurlPython

const response = await fetch('https://api.chainvine.xyz/api/v2/user/{user_id}/campaign/{campaign_id}/events/transfer', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "amount": 12443.43
    }),
});
const data = await response.json();

Response

200

{
  "amount": 12443.43,
  "requirement_id": "anId123",
  "external_identifier": "Ok",
  "fee": 134.32,
  "token_address": "Ok",
  "transaction_hash": "Ok",
  "usd_value": 134.32,
  "user_id": "Ok",
  "wallet_address": "Ok"
}

Mark a requirement as complete

Completes a requirement for a user within a referral program/campaign

https://docs.chainvine.xyz/technical/sdk/use-cases/requirements/completing-a-requirement-for-a-user

POSThttps://api.chainvine.xyz/api/v2/user/{user_id}/requirements/complete

Path parameters

user_id*string

Body

application/json

Linking a referral payload

campaign*CampaignRequestParameters (object)

id*string (slug)

The id of the requirement your wish to complete for the user

Example: "d0djj9dj9dj0jk"

Response

200400401

Referral was successfully registered

Body

application/json

messagestring

Example: "Ok"

Request

JavaScriptCurlPython

const response = await fetch('https://api.chainvine.xyz/api/v2/user/{user_id}/requirements/complete', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "id": "d0djj9dj9dj0jk",
      "campaign": {
        "id": "c5de90fe"
      }
    }),
});
const data = await response.json();

Response

200

{
  "message": "Ok"
}

V1 Endpoints

Record a link click

Records a click on a user's referral URL

POSThttps://api.chainvine.xyz/v1/chainvine/community/{community_id}/campaign/{campaign_id}/record-click

Path parameters

community_id*string

campaign_id*string

The campaign id to track the link click against

Query parameters

Body

application/json

Linking a referral payload

campaign_id*string (slug)

The campaign id you want to create a referral in

Example: "joidj2odkd"

referrer*string (uuid)

The referring user's Chainvine Id, obtained via the referral link r parameter

Example: "fjdopwdp2pmosjo2ds"

wallet_address*string

Example: "0x03jkd0ij2od"

Response

200400401

Link click was tracked

Request

JavaScriptCurlPython

const response = await fetch('https://api.chainvine.xyz/v1/chainvine/community/{community_id}/campaign/{campaign_id}/record-click?referrer=text', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "referrer": "fjdopwdp2pmosjo2ds",
      "wallet_address": "0x03jkd0ij2od",
      "campaign_id": "joidj2odkd"
    }),
});
const data = await response.json();

CodeGeneration

If you would like to generate custom code for the endpoints above, please visit our swaggerhub page and select the "Export" drop down at the top right of the page.