Boosts

Boosts Management

Last updated 17 days ago

Was this helpful?

Boosts

Boosts Management

1. Create a Boost

To create a boost, use the createBoost method. This method accepts a credential object (which can be an UnsignedVC or VC) and an optional metadata object.

const credential = your_credential;
const metadata = {
  name: 'Your Boost Name',
  description: 'Your Boost Description',
};

learnCard.invoke.createBoost(credential, metadata);

2. Get a Boost

To get a boost, use the getBoost method. This method accepts a uri parameter.

const uri = 'your_boost_uri';

learnCard.invoke.getBoost(uri);

3. Get Boosts

To retrieve all boosts, use the getBoosts method.

learnCard.invoke.getBoosts();

4. Get Boost Recipients

To get boost recipients, use the getBoostRecipients method. This method accepts a uri parameter and optional limit and skip parameters.

const uri = 'your_boost_uri';
const limit = 10;
const skip = 0;

learnCard.invoke.getBoostRecipients(uri, limit, skip);

5. Update a Boost

To update a boost, use the updateBoost method. This method accepts a uri parameter, an updates object, and a credential object (which can be an UnsignedVC or VC).

const uri = 'your_boost_uri';
const updates = {
  name: 'Updated Boost Name',
  description: 'Updated Boost Description',
};
const credential = updated_credential;

learnCard.invoke.updateBoost(uri, updates, credential);

6. Delete a Boost

To delete a boost, use the deleteBoost method. This method accepts a uri parameter.

const uri = 'your_boost_uri';

learnCard.invoke.deleteBoost(uri);

7. Send a Boost

To send a boost to another profile, use the sendBoost method. This method accepts a profileId, a boostUri parameter, and an optional encrypt parameteropconst profileId = 'janesmith';

const boostUri = 'your_boost_uri';
const encrypt = true;

learnCard.invoke.sendBoost(profileId, boostUri, encrypt);

These are the API calls related to boosts management in the LearnCard Network API. Use these methods to create, update, retrieve, and delete boosts, as well as send boosts to other profiles.

Claim a Boost

const boostUri = 'https://example.com/boost-uri';
const challenge = 'example-challenge';

await networkLearnCard.invoke.claimBoostWithLink(boostUri, challenge);

These examples demonstrate some of the ways you can interact with the LearnCard Network API using the @learncard/network-plugin.

PreviousCredentials NextPresentations

Last updated 17 days ago

Was this helpful?

1. Create a Boost

To create a boost, use the createBoost method. This method accepts a credential object (which can be an UnsignedVC or VC) and an optional metadata object.

const credential = your_credential;
const metadata = {
  name: 'Your Boost Name',
  description: 'Your Boost Description',
};

learnCard.invoke.createBoost(credential, metadata);

2. Get a Boost

To get a boost, use the getBoost method. This method accepts a uri parameter.

const uri = 'your_boost_uri';

learnCard.invoke.getBoost(uri);

3. Get Boosts

To retrieve all boosts, use the getBoosts method.

learnCard.invoke.getBoosts();

4. Get Boost Recipients

To get boost recipients, use the getBoostRecipients method. This method accepts a uri parameter and optional limit and skip parameters.

const uri = 'your_boost_uri';
const limit = 10;
const skip = 0;

learnCard.invoke.getBoostRecipients(uri, limit, skip);

5. Update a Boost

To update a boost, use the updateBoost method. This method accepts a uri parameter, an updates object, and a credential object (which can be an UnsignedVC or VC).

const uri = 'your_boost_uri';
const updates = {
  name: 'Updated Boost Name',
  description: 'Updated Boost Description',
};
const credential = updated_credential;

learnCard.invoke.updateBoost(uri, updates, credential);

6. Delete a Boost

To delete a boost, use the deleteBoost method. This method accepts a uri parameter.

const uri = 'your_boost_uri';

learnCard.invoke.deleteBoost(uri);

7. Send a Boost

To send a boost to another profile, use the sendBoost method. This method accepts a profileId, a boostUri parameter, and an optional encrypt parameteropconst profileId = 'janesmith';

const boostUri = 'your_boost_uri';
const encrypt = true;

learnCard.invoke.sendBoost(profileId, boostUri, encrypt);

These are the API calls related to boosts management in the LearnCard Network API. Use these methods to create, update, retrieve, and delete boosts, as well as send boosts to other profiles.

Claim a Boost

const boostUri = 'https://example.com/boost-uri';
const challenge = 'example-challenge';

await networkLearnCard.invoke.claimBoostWithLink(boostUri, challenge);

These examples demonstrate some of the ways you can interact with the LearnCard Network API using the @learncard/network-plugin.

Creates a boost

This route creates a boost

post

/boost/create

Authorizations

Body

namestring

typestring

categorystring

autoConnectRecipientsboolean

statusstring · enum

Options: DRAFT, LIVE

metaobject

claimPermissionsobject

credentialany ofrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '../api/boost/create' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"status":"DRAFT","meta":{"ANY_ADDITIONAL_PROPERTY":"anything"},"claimPermissions":{"canManageChildrenProfiles":false},"credential":{"issuanceDate":"text","type":[null],"credentialStatus":{"type":"text","id":"text","ANY_ADDITIONAL_PROPERTY":"anything"},"refreshService":{"id":"text","type":"text","ANY_ADDITIONAL_PROPERTY":"anything"},"@context":[],"credentialSchema":[{"id":"text","type":"text","ANY_ADDITIONAL_PROPERTY":"anything"}],"credentialSubject":{"ANY_ADDITIONAL_PROPERTY":"anything"},"proof":{"type":"text","created":"text","proofPurpose":"text","verificationMethod":"text","ANY_ADDITIONAL_PROPERTY":"anything"},"ANY_ADDITIONAL_PROPERTY":"anything"}}'

200

default

text

Successful response

Get boost

This endpoint gets metadata about a boost

get

/boost/{uri}

Authorizations

Path parameters

uristringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '../api/boost/{uri}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

default

{
  "name": "text",
  "type": "text",
  "category": "text",
  "autoConnectRecipients": true,
  "uri": "text",
  "status": "DRAFT",
  "meta": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "claimPermissions": {
    "role": "text",
    "canEdit": true,
    "canIssue": true,
    "canRevoke": true,
    "canManagePermissions": true,
    "canIssueChildren": "text",
    "canCreateChildren": "text",
    "canEditChildren": "text",
    "canRevokeChildren": "text",
    "canManageChildrenPermissions": "text",
    "canManageChildrenProfiles": false,
    "canViewAnalytics": true
  },
  "boost": {
    "id": "text",
    "issuanceDate": "text",
    "expirationDate": "text",
    "type": [
      "text"
    ],
    "credentialStatus": {
      "type": "text",
      "id": "text",
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "refreshService": {
      "id": "text",
      "type": "text",
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "@context": [
      "text"
    ],
    "credentialSchema": [
      {
        "id": "text",
        "type": "text",
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    ],
    "credentialSubject": {
      "id": "text",
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "issuer": "text",
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Successful response

Get boost recipients

Deprecated

This endpoint gets the recipients of a particular boost. Warning! This route is deprecated and currently has a hard limit of returning only the first 50 boosts. Please use getPaginatedBoostRecipients instead

get

/boost/recipients/{uri}

Authorizations

Path parameters

uristringrequired

Query parameters

limitany of · default: 25

skipnumber

includeUnacceptedBoostsboolean · default: true

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '../api/boost/recipients/{uri}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

default

[
  {
    "from": "text",
    "received": "text",
    "uri": "text",
    "to": {
      "profileId": "text",
      "displayName": "",
      "shortBio": "",
      "bio": "",
      "did": "text",
      "isPrivate": true,
      "email": "text",
      "image": "text",
      "heroImage": "text",
      "websiteLink": "text",
      "isServiceProfile": false,
      "type": "text",
      "notificationsWebhook": "https://example.com",
      "display": {
        "backgroundColor": "text",
        "backgroundImage": "text",
        "fadeBackgroundImage": true,
        "repeatBackgroundImage": true,
        "fontColor": "text",
        "accentColor": "text",
        "accentFontColor": "text",
        "idBackgroundImage": "text",
        "fadeIdBackgroundImage": true,
        "idBackgroundColor": "text",
        "repeatIdBackgroundImage": true
      }
    }
  }
]

Successful response

Delete a boost

This route deletes a boost

delete

/boost/{uri}

Authorizations

Path parameters

uristringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '../api/boost/{uri}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

default

true

Successful response

Send a Boost

This endpoint sends a boost to a profile

post

/boost/send/{profileId}

Authorizations

Path parameters

profileIdstringrequired

Body

uristringrequired

credentialany ofrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '../api/boost/send/{profileId}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"uri":"text","credential":{"issuanceDate":"text","type":[null],"credentialStatus":{"type":"text","id":"text","ANY_ADDITIONAL_PROPERTY":"anything"},"refreshService":{"id":"text","type":"text","ANY_ADDITIONAL_PROPERTY":"anything"},"@context":[],"credentialSchema":[{"id":"text","type":"text","ANY_ADDITIONAL_PROPERTY":"anything"}],"credentialSubject":{"ANY_ADDITIONAL_PROPERTY":"anything"},"proof":{"type":"text","created":"text","proofPurpose":"text","verificationMethod":"text","ANY_ADDITIONAL_PROPERTY":"anything"},"ANY_ADDITIONAL_PROPERTY":"anything"}}'

200

default

text

Successful response

Send a Credential

This endpoint sends a credential to a user based on their profileId

post

/credential/send/{profileId}

Authorizations

Path parameters

profileIdstringrequired

Body

credentialany ofrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '../api/credential/send/{profileId}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"credential":{"issuanceDate":"text","type":[null],"credentialStatus":{"type":"text","id":"text","ANY_ADDITIONAL_PROPERTY":"anything"},"refreshService":{"id":"text","type":"text","ANY_ADDITIONAL_PROPERTY":"anything"},"@context":[],"credentialSchema":[{"id":"text","type":"text","ANY_ADDITIONAL_PROPERTY":"anything"}],"credentialSubject":{"ANY_ADDITIONAL_PROPERTY":"anything"},"ANY_ADDITIONAL_PROPERTY":"anything"}}'

200

default

text

Successful response