NAV
shell javascript php

Getting Started

Welcome to ConsCent! This documentation covers all the steps for you to get set up - from optionally registering your premium content with ConsCent - which priced for a Pay per View basis, followed by integrating the paywall on your content pages and initialising the overlay to ensure all premium content is paid for.

You can get started by following the steps mentioned on the Using ConsCent Page.

Registration

The first step is registering your client with ConsCent. This is done by the ConsCent Team internally and your administrator will recieve the login credenitals (email & password) for the ConsCent Client Dashboard on the email they chose to register with. The client must provide a default value for the 'price', 'duration' and optionally geolocation overrides if the client wants geo-fenced pricing options. This will ensure that all the premium content on the clients website/app is micro-priced - even if the client doesn't register the content with ConsCent via API. (Price values are in INR)

By logging in to your ConsCent Client Dashboard and navigating to the Integrations Page. You will be able to view your active ClientId, API Key and API Secret.

Using ConsCent

Whenever you're utilising the Web Integration Code or Calling any ConsCent APIs - you to update the API_URL and SDK_URL variables based on the environment you're operating in.

Once you have registered your digital content on ConsCent, you need to integrate the paywall on all your Premium Content Pages.

Ensuring that the paywall appears each time any premium content is opened, as well as allowing users to purchase the content via ConsCent.

Integrating the paywall allows the users to purchase any of the Client's Content via ConsCent at Micropriced rates. The Web Integration section includes the steps involved in handling the Success and Failure Callbacks after the users go through the Concent Paywall, followed by validating each unique transaction incurred by a user on the any of the Clients Content.

Web Integration

ConsCent Paywall Initalisation Script:

<script>
  const clientId = '5f92a62013332e0f667794dc';
  (function (w, d, s, o, f, cid) {
    if (!w[o]) {
      w[o] = function () {
        w[o].q.push(arguments);
      };
      w[o].q = [];
    }
    (js = d.createElement(s)), (fjs = d.getElementsByTagName(s)[0]);
    js.id = o;
    js.src = f;
    js.async = 1;
    js.title = cid;
    fjs.parentNode.insertBefore(js, fjs);
  })(window, document, 'script', '_csc', {SDK_URL}, clientId);
</script>

Ensure you replace the 'clientId' with your actual Client ID retrieved from the Conscent Client Dashboard Integration Page and the {SDK_URL} with the sdk url of an environment you want to use, e.g. 'https://sandbox-sdk.conscent.in' for sandbox

Integrating ConsCent on your Website is a simple and direct process. You start by copying the code on the right hand side within the script tags - and adding it to the header section of your Route Index file.

You can get your ConsCent Client Id from the Client Integrations Page of the ConsCent Client Dashboard - as mentioned in the Registration Section.

Including this code in the header section allows the ConsCent Paywall to be initalised and further used whenever required on any Premium Content Page.

Finally, In order to ensure that the ConsCent Paywall appears on all pages which contain Premium Content. You need to implement the following function on the content page - included on the right hand side which calls the initalisation function '_csc' of the ConsCent Paywall and enables a user to purchase the particular premium content at a Micropriced value through ConsCent. Please ensure that you call this function anytime you want the ConsCent paywall to show up on your content page and that you have filtered for users that have subscribed to your platform beforehand and already have access to view the content and thus will not be going through the ConsCent paywall.

Include ConsCent Paywall on Premium Content Content Page:

const csc = window._csc;
csc('init', {
  debug: true, // can be set to false to remove sdk non-error log output
  contentId: contentId,
  subscriptionUrl: {clientSubscriptionUrl},
  signInUrl: {clientSignInUrl},
  clientId: clientId,
  title: contentTitle,
  isMobile: 'false',
  buttonMode,
  successCallback: yourSuccessCallbackFunction,
  wrappingElementId: 'csc-paywall',
  fullScreenMode: 'false', // if set to true, the entire screen will be covered,
  phoneNumber: 9898989898,
  email: test@email.com
})

Success Callback example:

async function yourSuccessCallbackFunction(validationObject: any) {
  // Function to show the premium content to the User since they have paid for it via ConsCent
  // Here you should verify the  validationObject with our backend
  // And then you must provide access to the user for the complete content

  // example verification code:
  console.log('Initiating verification with conscent backend');
  const xhttp = new XMLHttpRequest(); // using vanilla javascript to make a post request
  const url = `${API_URL}/api/v1/content/consumption/${validationObject.consumptionId}`;
  xhttp.open('POST', url, true);
  // e is the response event
  xhttp.onload = (e) => {
    const backendConfirmationData = JSON.parse(e.target.response);

    // verifying that the validation received matches the backend data
    if (
      validationObject.consumptionId === backendConfirmationData.consumptionId &&
      validationObject.payloadclientId === backendConfirmationData.payload.clientId &&
      validationObject.payload.contentId === backendConfirmationData.payload.contentId
    ) {
      // Validation successful
      console.log('successful validation');
      // accessContent would be your function that will do all the actions that need to be done to unlock the entire content
      accessContent(true);
    }
  };
  xhttp.send();
}

We import the initalisation script using the unique '_csc' identifier and run the 'init' function by passing a number of parameters:

Once the ConsCent Paywall has been initalised and the user has gone through the necessary steps needed to purchase the content via ConsCent - you need to implement a 'successCallback' function which will recieve a response containing a validationObject shown below - indicating whether the user has purchased the content, or if the user has access to the content already since they have purchased it before, or whether the transaction has failed and the user has not purchased the content.

{ "message": "Content Purchased Successfully", "payload": { "clientId": "5fbb40b07dd98b0e89d90a25", "contentId": "Client Content Id 5", "createdAt": "2020-12-29T05:51:31.116Z" }, "consumptionId": "a0c433af-a413-49e1-9f40-ce1fbd63f568", "signature": "74h9xm2479m7x792nxx247998975393x08y9hubrufyfy3348oqpqqpyg78fhfurifr3", }

The message "Content Purchased Successfully" appears in the response only when the user has purchased content via ConsCent and the "accessTimeLeft" field appears in the response only when the user has purchased the content previously and still has free access to consume the content. Moreover, the response contains a "consumptionId" field which will be used to verify each unique transaction by a user on the clients content with ConsCent.

Calling the Validate Content Consumption API using the recieved "consumptionId" in the successCallback response can assist the client in authenticating valid and unique transactions on their premium content.

The response validationObject from the 'Validate Content Consumption' API includes the same fields as mentioned in the validationObject above and matching the payload from the 'successCallback' response and 'Validate Content Consumption' response allows the client to ensure each transaction of any premium content via ConsCent is validated by matching the clientId, contentId, and createdAt (Date of Consumption/Transaction);

If the case arrives when the user tries to purchase any content via ConsCent on the client's website and the transaction fails. The client can handle that case as well in a 'failedCallback' function or redirect to any page - as the Client wishes.

Lastly, once the transaction has been validated by the Client - whether they choose to do it in the frontend or the backend - the client needs to provide access to the premium content purchased by the user. You can do this on the same page, or redirect the user to a different page containing the entirety of the premium content.

API Introduction

Welcome to the ConsCent Client API! You can use our APIs to access ConsCent Client API endpoints, which can help you get information on various tasks such as how to create content, verify payment for any content etc.

We have language bindings in Shell (cURL), PHP, and JavaScript! You can view code examples in the dark area to the right, and you can switch the programming language of the examples with the tabs in the top right.

Authentication

ConsCent uses API keys to allow access to the API for the Client to Create and Register any Content with ConsCent. You can view your API Key and Secret by logging in to your ConsCent Client Dashboard and navigating to the Integrations Page Client Integrations Page. Please contact your administrator for the Login Credentials to access the ConsCent Client Dashboard - provided on the official email address registered with ConsCent.

ConsCent expects for the API Key and Secret to be included as Basic Authentication in certain API requests (Ex. Create Content API utilised by the Client).

Authorization: Basic RDZXN1Y4US1NTkc0V1lDLVFYOUJQMkItOEU3QjZLRzpUNFNHSjlISDQ3TVpRWkdTWkVGVjZYUk5TS1E4RDZXN1Y4UU1ORzRXWUNRWDlCUDJCOEU3QjZLRw==

Client Content

Create Content


<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "{API_URL}/api/v1/content/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS =>'{
    "contentId" : "testingID For Client Content",
    "duration" : 30,
    "title" : "Test content for API functionality",
    "price" : 1,
    "currency": "INR",
    "url": "www.google.com",
    "contentType": "STORY",
    "tags": ["tag1", "tag2"],
    "priceOverrides": {
        "country": [
            {
                "name": "GL",
                "price": 3
            },
            {
                "name": "IN",
                "price": 5
            },
            {
                "name": "US",
                "price": 7
            }
        ]
    },
    "download": {
      "url": "https://yourdownloadurl.com",
      "fileName": "Download File - Name",
      "fileType": "PDF"
    },
    "pixels": {
        "facebook": {
            "pixelId": "98357934724994",
            "events": [
                {
                    "eventType": "VIEW",
                    "name": "PageView"
                },
                {
                    "eventType": "CONVERSION",
                    "name": "Purchase",
                    "data": {
                        "value": "dataValue"
                    }
                }
            ]
        },
        "google": {
            "trackingId": "G-RJDY8493"
        }
    }
  }',
  CURLOPT_HTTPHEADER => array(
    "Authorization: Basic RDZXN1Y4US1NTkc0V1lDLVFYOUJQMkItOEU3QjZLRzpUNFNHSjlISDQ3TVpRWkdTWkVGVjZYUk5TS1E4RDZXN1Y4UU1ORzRXWUNRWDlCUDJCOEU3QjZLRw==",
    "Content-Type: application/json"
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

curl -X POST '{API_URL}/api/v1/content/' \
-H 'Authorization: Basic RDZXN1Y4US1NTkc0V1lDLVFYOUJQMkItOEU3QjZLRzpUNFNHSjlISDQ3TVpRWkdTWkVGVjZYUk5TS1E4RDZXN1Y4UU1ORzRXWUNRWDlCUDJCOEU3QjZLRw==' \
-H 'Content-Type: application/json' \
-d '{
    "contentId" : "testingID For Client Content",
    "duration" : 30,
    "title" : "Test content for API functionality",
    "price" : 1,
    "currency": "INR",
    "tags": ["tag1", "tag2"],
    "contentType": "STORY",
    "url": "www.google.com",
    "priceOverrides": {
        "country": [
            {
                "name": "GL",
                "price": 3
            },
            {
                "name": "IN",
                "price": 5
            },
            {
                "name": "US",
                "price": 7
            }
        ]
    },
    "download": {
      "url": "https://yourdownloadurl.com",
      "fileName": "Download File - Name",
      "fileType": "PDF"
    },
    "pixels": {
        "facebook": {
            "pixelId": "98357934724994",
            "events": [
                {
                    "eventType": "VIEW",
                    "name": "PageView"
                },
                {
                    "eventType": "CONVERSION",
                    "name": "Purchase",
                    "data": {
                        "value": "dataValue"
                    }
                }
            ]
        },
        "google": {
            "trackingId": "G-RJDY8493"
        }
    }
}'
var axios = require("axios");
var data = JSON.stringify({
  contentId: "testingID For Client",
  duration: 30,
  title: "Test content for API functionality",
  price: 1,
  currency: "INR",
  url: "www.google.com",
  contentType: "STORY",
  tags: ["tag1", "tag2"],
  priceOverrides: {
    country: [
      { name: "GL", price: 3 },
      { name: "IN", price: 5 },
      { name: "US", price: 7 },
    ],
  },
  download: {
    url: "https://yourdownloadurl.com",
    fileName: "Download File - Name",
    fileType: "PDF",
  },
  pixels: {
    facebook: {
      pixelId: "98357934724994",
      events: [
        {
          eventType: "VIEW",
          name: "PageView",
        },
        {
          eventType: "CONVERSION",
          name: "Purchase",
          data: {
            value: "dataValue",
          },
        },
      ],
    },
    google: {
      trackingId: "G-RJDY8493",
    },
  },
});

var config = {
  method: "post",
  url: "{API_URL}/api/v1/content/",
  headers: {
    Authorization:
      "Basic RDZXN1Y4US1NTkc0V1lDLVFYOUJQMkItOEU3QjZLRzpUNFNHSjlISDQ3TVpRWkdTWkVGVjZYUk5TS1E4RDZXN1Y4UU1ORzRXWUNRWDlCUDJCOEU3QjZLRw==",
    "Content-Type": "application/json",
  },
  data: data,
};

axios(config)
  .then(function (response) {
    console.log(JSON.stringify(response.data));
  })
  .catch(function (error) {
    console.log(error);
  });

The above command returns JSON structured like this:

{
  "message": "New Content Created!",
  "content": {
    "title": "Test content for API functionality",
    "price": 1,
    "currency": "INR",
    "contentId": "testingID For Client Content",
    "duration": 30,
    "url": "www.google.com",
    "contentType": "STORY",
    "tags": ["tag1", "tag2"],
    "priceOverrides": {
      "country": [
        {
          "_id": "605b25824646e9233aef61b4",
          "name": "GL",
          "price": 3
        },
        {
          "_id": "605b25824646e9233aef61b5",
          "name": "IN",
          "price": 5
        },
        {
          "_id": "605b25824646e9233aef61b6",
          "name": "US",
          "price": 7
        }
      ]
    },
    "download": {
      "url": "https://yourdownloadurl.com",
      "fileName": "Download File - Name",
      "fileType": "PDF",
      "s3Key": "KeyForDownloadedFileOnS3"
    },
    "pixels": {
      "facebook": {
        "pixelId": "98357934724994",
        "events": [
          {
            "eventType": "VIEW",
            "name": "PageView"
          },
          {
            "eventType": "CONVERSION",
            "name": "Purchase",
            "data": {
              "value": "dataValue"
            }
          }
        ]
      },
      "google": {
        "trackingId": "G-RJDY8493"
      }
    }
  }
}

This endpoint allows the Client to Register their Content on ConsCent - with the Content Title, ContentId, Content URL, Tags, Analytics Pixels (Facebook and Google), Price as well as any specific Price Overrides for a country - In order to set a different price for the content in the relevant country. Moreover, the Client can also set the duration of a content - which means that if a content if purchased by a user on ConsCent, then that user can have free access to the content for {duration} amount of time. By Default we use a 1 Day duration. Moreover, the ContentType field is optional - and if no 'contentType' is provided then the default 'contentType' of the client will be treated as the 'contentType' of the content being registered. While category based pricing can be used for any content, by passing the priceCategory field on registering the content - as long as the price category has been registered by the client on the ConsCent dashboard along with its respective price, duration and priceOverrides; however, category based pricing only comes into effect if the content does not have a pre-determined price field (price must be null); Moreover, if the content is downloadable on purchase, then the client can pass the download "url", "fileName" and "fileType" in the download object of the request body while creating the content. Finally, the client can pass a 'pixels' object in the request body which can contain either/or facebook and google pixel data - to ensure that the client's pixel events are fired on particular occurances relating to the content (Page View or Purchase of the Content). The pixel object must be passed in accordance with the format provided in the sample requests. Please note that the pixels are NOT fired when a user has blocked 3rd party cookies.

HTTP Request

POST {API_URL}/api/v1/content

Authorization

Client API Key and Secret must be passed in Authorization Headers using Basic Auth. With API Key as the Username and API Secret as the password.

Request Body

Parameter Default Description
contentId required Content Id by which the Content has been registered on the Client CMS. Please ensure that the content ID is at most 32 characters and can only contain letters, numbers, underscores and dashes.
title required Title of the Content
price optional Content Price for pay-per-use pricing
currency optional Currency in which price is determined. Must be an ISO 4217 supported - 3 Digit currency Code. INR is used as the default if no value is provided.
url required URL where the content is available on your website
duration optional Free content access time for user once the user has purchased the content. (Standard Practice - 1 Day);
authorId optional Id of the Author of the content - Mandatory if authorName is present
authorName optional Name of the Author of the content
contentType optional Must be an ENUM from one of the following - STORY, VIDEO, SONG, PODCAST, PREMIUM CONTENT
priceOverrides optional Price Overrides for any particular country with the relevant country code as the name and the ENUM value in the price. The country code list is located the end of this document
download optional Object containing the "url", "fileName" and "fileType". All download parameters must be provided if the content is downloadable on purchase. Also, the "fileType" is an ENUM and only accepts "PDF" currently.
priceCategory optional The priceCategory of the content, which has been registered by the client on the ConsCent Client Dashboard - in order to invoke category based pricing (only valid if story doesn't have a price). Each registered priceCategory will have an associated price, currency, duration and priceOverrides.
pixels optional A nested object with the optional keys being "facebook" and "google". With the "google" object only requiring the trackingId - to include the gtag throughout the platform. However, for the "facebook" object the "pixelId" must be passed along with an "events" array - containing the event name (as configured on the facebook events manager), the eventType (which is an ENUM to be chosen from ["VIEW", "CONVERSION"]) as well as any data/values associated with the particular event.
tags optional Array of tags associated with the content

Edit Content

Please ensure you URL encode the contentId in the Path Parameters Replace the {contentId} in the API path with your actual Content Id

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "{API_URL}/api/v1/content/Client%20Content%20Id%2011",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
   CURLOPT_POSTFIELDS =>'{
    "contentId" : "testingID For Client Content",
    "duration" : 30,
    "title" : "Test content for API functionality Edited",
    "price" : 1,
    "currency": "INR",
    "url": "www.google.com",
    "contentType": "PREMIUM CONTENT",
    "tags": ["tag3"],
    "priceOverrides": {
        "country": [
            {
                "name": "GL",
                "price": 2
            },
            {
                "name": "IN",
                "price": 1
            },
            {
                "name": "US",
                "price": 0
            }
        ]
    },
    "download": {
      "url": "https://yourdownloadurl.com",
      "fileName": "Download File - Edited Name",
      "fileType": "PDF"
    },
    "pixels": {
        "facebook": {
            "pixelId": "98357934724994",
            "events": [
                {
                    "eventType": "VIEW",
                    "name": "PageView"
                },
                {
                    "eventType": "CONVERSION",
                    "name": "Purchase",
                    "data": {
                        "value": "dataValue"
                    }
                }
            ]
        },
        "google": {
            "trackingId": "G-RJDY8493"
        }
    }
}',
  CURLOPT_HTTPHEADER => array(
    "Authorization: Basic RDZXN1Y4US1NTkc0V1lDLVFYOUJQMkItOEU3QjZLRzpUNFNHSjlISDQ3TVpRWkdTWkVGVjZYUk5TS1E4RDZXN1Y4UU1ORzRXWUNRWDlCUDJCOEU3QjZLRw==",
    "Content-Type: application/json"
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

curl -X PATCH '{API_URL}/api/v1/content/{contentId}' \
-H 'Authorization: Basic RDZXN1Y4US1NTkc0V1lDLVFYOUJQMkItOEU3QjZLRzpUNFNHSjlISDQ3TVpRWkdTWkVGVjZYUk5TS1E4RDZXN1Y4UU1ORzRXWUNRWDlCUDJCOEU3QjZLRw==' \
-H 'Content-Type: application/json' \
-d '{
    "contentId" : "testingID For Client Content",
    "duration" : 30,
    "title" : "Test content for API functionality Edited",
    "price" : 1,
    "currency": "INR",
    "tags": ["tag3"],
    "url": "www.google.com",
    "contentType": "PREMIUM CONTENT",
    "priceOverrides": {
        "country": [
            {
                "name": "GL",
                "price": 2
            },
            {
                "name": "IN",
                "price": 1
            },
            {
                "name": "US",
                "price": 0
            }
        ]
    },
    "download": {
      "url": "https://yourdownloadurl.com",
      "fileName": "Download File - Edited Name",
      "fileType": "PDF"
    },
    "pixels": {
        "facebook": {
            "pixelId": "98357934724994",
            "events": [
                {
                    "eventType": "VIEW",
                    "name": "PageView"
                },
                {
                    "eventType": "CONVERSION",
                    "name": "Purchase",
                    "data": {
                        "value": "dataValue"
                    }
                }
            ]
        },
        "google": {
            "trackingId": "G-RJDY8493"
        }
    }
}'
var axios = require("axios");
var data = JSON.stringify({
  contentId: "testingID For Client Content",
  duration: 30,
  title: "Test content for API functionality Edited",
  price: 1,
  currency: "INR",
  tags: ["tag3"],
  url: "www.google.com",
  contentType: "PREMIUM CONTENT",
  priceOverrides: {
    country: [
      { name: "GL", price: 2 },
      { name: "IN", price: 1 },
      { name: "US", price: 0 },
    ],
  },
  download: {
    url: "https://yourdownloadurl.com",
    fileName: "Download File - Edited Name",
    fileType: "PDF",
  },
  pixels: {
    facebook: {
      pixelId: "98357934724994",
      events: [
        {
          eventType: "VIEW",
          name: "PageView",
        },
        {
          eventType: "CONVERSION",
          name: "Purchase",
          data: {
            value: "dataValue",
          },
        },
      ],
    },
    google: {
      trackingId: "G-RJDY8493",
    },
  },
});

var config = {
  method: "patch",
  url: "{API_URL}/api/v1/content/{contentId}",
  headers: {
    Authorization:
      "Basic RDZXN1Y4US1NTkc0V1lDLVFYOUJQMkItOEU3QjZLRzpUNFNHSjlISDQ3TVpRWjnJL877NJSjnkHSk5TS1E4RDZXN1Y4UU1ORzRXWUNRWDlCUDJCOEU3QjZLRw==",
    "Content-Type": "application/json",
  },
  data: data,
};

axios(config)
  .then(function (response) {
    console.log(JSON.stringify(response.data));
  })
  .catch(function (error) {
    console.log(error);
  });

The above command returns JSON structured like this:

{
  "message": "Content Edited Successfully",
  "editedContent": {
    "title": "Client Content Id Test Edited",
    "contentId": "testingID For Client Content",
    "price": 1,
    "currency": "INR",
    "duration": 30,
    "tags": ["tag3"],
    "url": "https://www.yoursite.com/yournewcontent",
    "contentType": "PREMIUM CONTENT",
    "authorName": "changed-author-name",
    "authorId": "changed-unique-author-id",
    "priceOverrides": {
      "country": [
        {
          "_id": "605b25824646e9233aef61b4",
          "name": "GL",
          "price": 2
        },
        {
          "_id": "605b25824646e9233aef61b5",
          "name": "IN",
          "price": 1
        },
        {
          "_id": "605b25824646e9233aef61b6",
          "name": "US",
          "price": 0
        }
      ]
    },
    "download": {
      "url": "https://yourdownloadurl.com",
      "fileName": "Download File - Edited Name",
      "fileType": "PDF",
      "s3Key": "KeyForDownloadedFileOnS3"
    },
    "pixels": {
      "facebook": {
        "pixelId": "98357934724994",
        "events": [
          {
            "eventType": "VIEW",
            "name": "PageView"
          },
          {
            "eventType": "CONVERSION",
            "name": "Purchase",
            "data": {
              "value": "dataValue"
            }
          }
        ]
      },
      "google": {
        "trackingId": "G-RJDY8493"
      }
    }
  }
}

This endpoint allows the Client to Edit their Registered Content on ConsCent - with the editable fields being the Content title, price, currency, priceOverrides, tags, URL, duration, contentType, download, category and pixels . Content ID CANNOT be edited!

HTTP Request

PATCH {API_URL}/api/v1/content/{contentId}

Authorization

Client API Key and Secret must be passed in Authorization Headers using Basic Auth. With API Key as the Username and API Secret as the password.

URL Parameters

Parameter Description
contentId The ID of the Content you wish to edit ( Ensure it is URL Encoded)

Request Body

Parameter Default Description
title optional Title of the Content
price optional Content Price for Pay-per-use pricing
currency optional Currency in which price is determined. Must be an ISO 4217 supported - 3 Digit currency Code. INR is used as the default if no value is provided.
url optional URL where the content is available on your website
duration optional Free content access time for user once the user has purchased the content. (Standard Practice - 1 Day);
authorId optional Id of the Author of the content - Mandatory if authorName is present
authorName optional Name of the Author of the content
contentType optional Must be an ENUM from one of the following - STORY, VIDEO, SONG, PODCAST, PREMIUM CONTENT
priceOverrides optional Price Overrides for any particular country with the relevant country code as the name and the ENUM value in the price. The country code list is located the end of this document
download optional Object containing the "url", "fileName" and "fileType". All download parameters must be provided if the content is downloadable on purchase. Also, the "fileType" is an ENUM and only accepts "PDF" currently
priceCategory optional The priceCategory of the content, which has been registered by the client on the ConsCent Client Dashboard - in order to invoke category based pricing (only valid if story doesn't have a price). Each registered priceCategory will have an associated price, currency, duration and priceOverrides
pixels optional A nested object with the optional keys being "facebook" and "google". With the "google" object only requiring the trackingId - to include the gtag throughout the platform. However, for the "facebook" object the "pixelId" must be passed along with an "events" array - containing the event name (as configured on the facebook events manager), the eventType (which is an ENUM to be chosen from ["VIEW", "CONVERSION"]) as well as any data/values associated with the particular event.
tags optional Array of tags associated with the content

View All Content

API to retrieve all of the client's content registered on ConsCent.

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "{API_URL}/api/v1/content/client",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => array(
    "Authorization: Basic RDZXN1Y4US1NTkc0V1lDLVFYOUJQMkItOEU3QjZLRzpUNFNHSjlISDQ3TVpRWkdTWkVGVjZYUk5TS1E4RDZXN1Y4UU1ORzRXWUNRWDlCUDJCOEU3QjZLRw=="
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;


curl -X GET '{API_URL}/api/v1/content/client' \
-H 'Authorization: Basic RDZXN1Y4US1NTkc0V1lDLVFYOUJQMkItOEU3QjZLRzpUNFNHSjlISDQ3TVpRWkdTWkVGVjZYUk5TS1E4RDZXN1Y4UU1ORzRXWUNRWDlCUDJCOEU3QjZLRw=='
var axios = require("axios");

var config = {
  method: "get",
  url: "{API_URL}/api/v1/content/client",
  headers: {
    Authorization:
      "Basic RDZXN1Y4US1NTkc0V1lDLVFYOUJQMkItOEU3QjZLRzpUNFNHSjlISDQ3TVpRWkdTWkVGVjZYUk5TS1E4RDZXN1Y4UU1ORzRXWUNRWDlCUDJCOEU3QjZLRw==",
  },
};

axios(config)
  .then(function (response) {
    console.log(JSON.stringify(response.data));
  })
  .catch(function (error) {
    console.log(error);
  });

The above command returns JSON structured like this:

{
  "content": [
    {
      "title": "Client Content Id Test Edit 1",
      "contentId": "Client Content Id 11",
      "price": 1,
      "currency": "INR",
      "duration": 2,
      "tags": ["tag1", "tag2"],
      "url": "https://www.yoursite.com/yourcontent",
      "contentType": "STORY",
      "priceOverrides": {
        "country": [
          {
            "_id": "605b25824646e9233aef61b4",
            "name": "GL",
            "price": 2
          }
        ]
      }
    },
    {
      "title": "Test content for API functionality",
      "contentId": "testingID for Client Content",
      "price": 3,
      "currency": "INR",
      "tags": ["tag3"],
      "duration": 2,
      "url": "https://www.yoursite.com/yourcontent",
      "contentType": "STORY",
      "download": {
        "url": "https://yourdownloadurl.com",
        "fileName": "Download File - Name",
        "fileType": "PDF",
        "s3Key": "KeyForDownloadedFileOnS3"
      }
    }
  ],
  "pagination": {
    "pageNumber": 1,
    "pageSize": 20,
    "totalRecords": 2,
    "totalPages": 1
  }
}

This endpoint allows the Client to view their entire collection of Registered Content on ConsCent. With each retrieved content containing the following details - Title, Price, URL, Content ID and duration.

HTTP Request

GET {API_URL}/api/v1/content/client

Authorization

Client API Key and Secret must be passed in Authorization Headers using Basic Auth. With API Key as the Username and API Secret as the password.

URL Parameters

Parameter Default Description
pageNumber optional Pagination Parameters - which page of the contents list you would like to retrieve (default = 1). Since each page will have 20 (default) individual contents ONLY.
pageSize optional Pagination Parameters - the number of individual contents to retrieve on each page (default = 20).

View Content Details

Please ensure you URL encode the contentId in the Path Parameters Replace the {contentId} in the API path with your actual Content Id

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "{API_URL}/api/v1/content/client/Client%20Content%20Id%206",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => array(
    "Authorization: Basic RDZXN1Y4US1NTkc0V1lDLVFYOUJQMkItOEU3QjZLRzpUNFNHSjlISDQ3TVpRWkdTWkVGVjZYUk5TS1E4RDZXN1Y4UU1ORzRXWUNRWDlCUDJCOEU3QjZLRw=="
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

curl -X GET '{API_URL}/api/v1/content/client/Client%20Content%20Id%206' \
-H 'Authorization: Basic RDZXN1Y4US1NTkc0V1lDLVFYOUJQMkItOEU3QjZLRzpUNFNHSjlISDQ3TVpRWkdTWkVGVjZYUk5TS1E4RDZXN1Y4UU1ORzRXWUNRWDlCUDJCOEU3QjZLRw=='
var axios = require("axios");

var config = {
  method: "get",
  url: "{API_URL}/api/v1/content/client/Client%20Content%20Id%206",
  headers: {
    Authorization:
      "Basic RDZXN1Y4US1NTkc0V1lDLVFYOUJQMkItOEU3QjZLRzpUNFNHSjlISDQ3TVpRWkdTWkVGVjZYUk5TS1E4RDZXN1Y4UU1ORzRXWUNRWDlCUDJCOEU3QjZLRw==",
  },
};

axios(config)
  .then(function (response) {
    console.log(JSON.stringify(response.data));
  })
  .catch(function (error) {
    console.log(error);
  });

The above command returns JSON structured like this:

{
  "title": "Tesla Tequila",
  "contentId": "Client Content Id 6",
  "tags": ["tag3"],
  "price": 1,
  "currency": "INR",
  "url": "https://www.yoursite.com/yourcontent",
  "duration": 1,
  "contentType": "STORY",
  "priceOverrides": {
    "country": [
      {
        "_id": "605b25824646e9233aef61b4",
        "name": "GL",
        "price": 2
      }
    ]
  }
}

This endpoint allows the Client to retrieve a particular content which they registered with ConsCent - including the details of the content such as the Content ID, title, price, currency, URL, duration, contentType and priceCategory.

HTTP Request

GET {API_URL}/api/v1/content/client/{contentId}

Authorization

Client API Key and Secret must be passed in Authorization Headers using Basic Auth. With API Key as the Username and API Secret as the password.

URL Parameters

Parameter Description
contentId The ID of the Content you wish to retrieve (Please ensure its URL Encoded)

Client Content Bundles

Create Content Bundle


<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "{API_URL}/api/v1/content/bundle",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS =>'{
    "contentId" : "Client Content Bundle 1",
    "duration" : 30,
    "title" : "Test content bundle for API functionality",
    "price" : 10,
    "currency": "INR",
    "url": "www.google.com",
    "tags": ["tag4", "tag5"],
    "contentType": "STORY",
    "priceOverrides": {
        "country": [
            {
                "name": "GL",
                "price": 3
            },
            {
                "name": "IN",
                "price": 5
            },
            {
                "name": "US",
                "price": 7
            }
        ]
    },
    "bundleContentIds": ["Content Id 1", "Content Id 2", "Content Id 3"],
  }',
  CURLOPT_HTTPHEADER => array(
    "Authorization: Basic RDZXN1Y4US1NTkc0V1lDLVFYOUJQMkItOEU3QjZLRzpUNFNHSjlISDQ3TVpRWkdTWkVGVjZYUk5TS1E4RDZXN1Y4UU1ORzRXWUNRWDlCUDJCOEU3QjZLRw==",
    "Content-Type: application/json"
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

curl -X POST '{API_URL}/api/v1/content/bundle' \
-H 'Authorization: Basic RDZXN1Y4US1NTkc0V1lDLVFYOUJQMkItOEU3QjZLRzpUNFNHSjlISDQ3TVpRWkdTWkVGVjZYUk5TS1E4RDZXN1Y4UU1ORzRXWUNRWDlCUDJCOEU3QjZLRw==' \
-H 'Content-Type: application/json' \
-d '{
    "contentId" : "Client Content Bundle 1",
    "bundleContentIds": ["Content Id 1", "Content Id 2", "Content Id 3"],
    "duration" : 30,
    "title" : "Test content bundle for API functionality",
    "price" : 10,
    "currency": "INR",
    "tags": ["tag4", "tag5"],
    "contentType": "STORY",
    "url": "www.google.com",
    "priceOverrides": {
        "country": [
            {
                "name": "GL",
                "price": 3
            },
            {
                "name": "IN",
                "price": 5
            },
            {
                "name": "US",
                "price": 7
            }
        ]
    },
}'
var axios = require("axios");
var data = JSON.stringify({
  contentId: "Client Content Bundle 1",
  bundleContentIds: ["Content Id 1", "Content Id 2", "Content Id 3"],
  duration: 30,
  title: "Test content bundle for API functionality",
  price: 10,
  currency: "INR",
  tags: ["tag4", "tag5"],
  url: "www.google.com",
  contentType: "STORY",
  priceOverrides: {
    country: [
      { name: "GL", price: 3 },
      { name: "IN", price: 5 },
      { name: "US", price: 7 },
    ],
  },
});

var config = {
  method: "post",
  url: "{API_URL}/api/v1/content/bundle",
  headers: {
    Authorization:
      "Basic RDZXN1Y4US1NTkc0V1lDLVFYOUJQMkItOEU3QjZLRzpUNFNHSjlISDQ3TVpRWkdTWkVGVjZYUk5TS1E4RDZXN1Y4UU1ORzRXWUNRWDlCUDJCOEU3QjZLRw==",
    "Content-Type": "application/json",
  },
  data: data,
};

axios(config)
  .then(function (response) {
    console.log(JSON.stringify(response.data));
  })
  .catch(function (error) {
    console.log(error);
  });

The above command returns JSON structured like this:

{
  "message": "New Content Created!",
  "content": {
    "title": "Test content bundle for API functionality",
    "price": 10,
    "currency": "INR",
    "contentId": "Client Content Bundle 1",
    "bundleContentIds": ["Content Id 1", "Content Id 2", "Content Id 3"],
    "tags": ["tag4", "tag5"],
    "duration": 30,
    "url": "www.google.com",
    "contentType": "STORY",
    "priceOverrides": {
      "country": [
        {
          "_id": "605b25824646e9233aef61b4",
          "name": "GL",
          "price": 3
        },
        {
          "_id": "605b25824646e9233aef61b5",
          "name": "IN",
          "price": 5
        },
        {
          "_id": "605b25824646e9233aef61b6",
          "name": "US",
          "price": 7
        }
      ]
    }
  }
}

This endpoint allows the Client to Register their Content Bundle on ConsCent - with the Content Title, ContentId, BundleContentIds, Content URL, Tags, Price, Currency, as well as any specific Price Overrides for a country - In order to set a different price for the content bundle in the relevant country. Moreover, the Client can also set the duration of a content bundle - which means that if a bundle if purchased by a user on ConsCent, then that user can have free access to all the content in the bundle for {duration} amount of time. By Default we use a 1 Day duration. Moreover, the ContentType field is optional - and if no 'contentType' is provided then the default 'contentType' of the client will be treated as the 'contentType' of the content being registered. While category based pricing can be used for any content bundle, by passing the priceCategory field on registering the content - as long as the priceCategory has been registered by the client on the ConsCent dashboard along with its respective price, duration and priceOverrides; however, category based pricing only comes into effect if the content does not have a pre-determined price field (price must be null); Lastly, the bundleContentIds must be the unique Ids of the client's contents that have been registered with ConsCent previously. Any mismatch in the bundleContentIds will throw an error - so ensure the contentIds that are to be part of the bundle are registered and passed to the API call correctly.

HTTP Request

POST {API_URL}/api/v1/content/bundle

Authorization

Client API Key and Secret must be passed in Authorization Headers using Basic Auth. With API Key as the Username and API Secret as the password.

Request Body

Parameter Default Description
contentId required Unique Content Id by which the Content Bundle will be determined and registered
bundleContentIds required Array of ContentIds - which have been registered on ConsCent by the client and are to be grouped together for purchase - in this bundle
title required Title of the Content Bundle
price optional Content Bundle Price
currency optional Currency in which price is determined. Must be an ISO 4217 supported - 3 Digit currency Code. INR is used as the default if no value is provided.
url required URL where the content bundle is available on your website
duration optional Free content access time for user once the user has purchased the content bundle. (Standard Practice - 1 Day);
contentType optional Must be an ENUM from one of the following - STORY, VIDEO, SONG, PODCAST, PREMIUM CONTENT
priceOverrides optional Price Overrides for any particular country with the relevant country code as the name and the ENUM value in the price. The country code list is located the end of this document
priceCategory optional The priceCategory of the content bundle, which has been registered by the client on the ConsCent Client Dashboard - in order to invoke category based pricing (only valid if story doesn't have a price). Each registered priceCategory will have an associated price, currency, duration and priceOverrides.
tags optional Array of tags associated with the content bundle

Edit Content Bundle

Please ensure you URL encode the contentId in the Path Parameters Replace the {contentId} in the API path with your actual Content Id

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "{API_URL}/api/v1/content/bundle/Client%20Content%20Bundle%2011",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
   CURLOPT_POSTFIELDS =>'{
    "contentId" : "Client Content Bundle 1",
    "bundleContentIds": ["Content Id 1", "Content Id 2", "Content Id 3"],
    "duration" : 30,
    "title" : "Test content bundle for API functionality Edited",
    "price" : 15,
    "tags": ["tag7"],
    "currency": "INR",
    "url": "www.google.com",
    "contentType": "PREMIUM CONTENT",
    "priceOverrides": {
        "country": [
            {
                "name": "GL",
                "price": 2
            },
            {
                "name": "IN",
                "price": 1
            },
            {
                "name": "US",
                "price": 0
            }
        ]
    },

}',
  CURLOPT_HTTPHEADER => array(
    "Authorization: Basic RDZXN1Y4US1NTkc0V1lDLVFYOUJQMkItOEU3QjZLRzpUNFNHSjlISDQ3TVpRWkdTWkVGVjZYUk5TS1E4RDZXN1Y4UU1ORzRXWUNRWDlCUDJCOEU3QjZLRw==",
    "Content-Type: application/json"
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

curl -X PATCH '{API_URL}/api/v1/content/bundle/{contentId}' \
-H 'Authorization: Basic RDZXN1Y4US1NTkc0V1lDLVFYOUJQMkItOEU3QjZLRzpUNFNHSjlISDQ3TVpRWkdTWkVGVjZYUk5TS1E4RDZXN1Y4UU1ORzRXWUNRWDlCUDJCOEU3QjZLRw==' \
-H 'Content-Type: application/json' \
-d '{
    "contentId" : "Client Content Bundle 1",
    "bundleContentIds": ["Content Id 1", "Content Id 2", "Content Id 3"],
    "duration" : 30,
    "title" : "Test content bundle for API functionality Edited",
    "price" : 15,
    "currency": "INR",
    "tags": ["tag7"],
    "url": "www.google.com",
    "contentType": "PREMIUM CONTENT",
    "priceOverrides": {
        "country": [
            {
                "name": "GL",
                "price": 2
            },
            {
                "name": "IN",
                "price": 1
            },
            {
                "name": "US",
                "price": 0
            }
        ]
    },
}'
var axios = require("axios");
var data = JSON.stringify({
  contentId: "Client Content Bundle 1",
  bundleContentIds: ["Content Id 1", "Content Id 2", "Content Id 3"],
  duration: 30,
  title: "Test content bundle for API functionality Edited",
  price: 15,
  currency: "INR",
  url: "www.google.com",
  contentType: "PREMIUM CONTENT",
  tags: ["tag7"],
  priceOverrides: {
    country: [
      { name: "GL", price: 2 },
      { name: "IN", price: 1 },
      { name: "US", price: 0 },
    ],
  },
});

var config = {
  method: "patch",
  url: "{API_URL}/api/v1/content/bundle/{contentId}",
  headers: {
    Authorization:
      "Basic RDZXN1Y4US1NTkc0V1lDLVFYOUJQMkItOEU3QjZLRzpUNFNHSjlISDQ3TVpRWjnJL877NJSjnkHSk5TS1E4RDZXN1Y4UU1ORzRXWUNRWDlCUDJCOEU3QjZLRw==",
    "Content-Type": "application/json",
  },
  data: data,
};

axios(config)
  .then(function (response) {
    console.log(JSON.stringify(response.data));
  })
  .catch(function (error) {
    console.log(error);
  });

The above command returns JSON structured like this:

{
  "message": "Content Edited Successfully",
  "editedContent": {
    "title": "Test content bundle for API functionality Edited",
    "contentId": "Client Content Bundle 1",
    "bundleContentIds": ["Content Id 1", "Content Id 2", "Content Id 3"],
    "price": 15,
    "currency": "INR",
    "duration": 30,
    "tags": ["tag7"],
    "url": "https://www.yoursite.com/yournewcontent",
    "contentType": "PREMIUM CONTENT",
    "priceOverrides": {
      "country": [
        {
          "_id": "605b25824646e9233aef61b4",
          "name": "GL",
          "price": 2
        },
        {
          "_id": "605b25824646e9233aef61b5",
          "name": "IN",
          "price": 1
        },
        {
          "_id": "605b25824646e9233aef61b6",
          "name": "US",
          "price": 0
        }
      ]
    }
  }
}

This endpoint allows the Client to Edit their Registered Content Bundle on ConsCent - with the editable fields being the bundleContentIds as well as the bundle title, price, currency, priceOverrides, URL, duration, contentType and priceCategory. The Bundle Content ID CANNOT be edited!

HTTP Request

PATCH {API_URL}/api/v1/content/bundle/{contentId}

Authorization

Client API Key and Secret must be passed in Authorization Headers using Basic Auth. With API Key as the Username and API Secret as the password.

URL Parameters

Parameter Description
contentId The ID of the Content Bundle you wish to edit ( Ensure it is URL Encoded)

Request Body

Parameter Default Description
title optional Title of the Content Bundle
bundleContentIds optional Array of ContentIds - which have been registered on ConsCent by the client and are to be grouped together for purchase - in this bundle
price optional Content Bundle Price
currency optional Currency in which price is determined. Must be an ISO 4217 supported - 3 Digit currency Code. INR is used as the default if no value is provided.
url optional URL where the content bundle is available on your website
duration optional Free content access time for user once the user has purchased the content bundle. (Standard Practice - 1 Day);
contentType optional Must be an ENUM from one of the following - STORY, VIDEO, SONG, PODCAST, PREMIUM CONTENT
priceOverrides optional Price Overrides for any particular country with the relevant country code as the name and the ENUM value in the price. The country code list is located the end of this document
priceCategory optional The priceCategory of the content bundle, which has been registered by the client on the ConsCent Client Dashboard - in order to invoke category based pricing (only valid if story doesn't have a price). Each registered priceCategory will have an associated price, currency, duration and priceOverrides
tags optional Array of tags associated with the content bundle

View All Content Bundles

API to retrieve all of the client's content bundles registered on ConsCent.

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "{API_URL}/api/v1/content/bundles",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => array(
    "Authorization: Basic RDZXN1Y4US1NTkc0V1lDLVFYOUJQMkItOEU3QjZLRzpUNFNHSjlISDQ3TVpRWkdTWkVGVjZYUk5TS1E4RDZXN1Y4UU1ORzRXWUNRWDlCUDJCOEU3QjZLRw=="
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;


curl -X GET '{API_URL}/api/v1/content/bundles' \
-H 'Authorization: Basic RDZXN1Y4US1NTkc0V1lDLVFYOUJQMkItOEU3QjZLRzpUNFNHSjlISDQ3TVpRWkdTWkVGVjZYUk5TS1E4RDZXN1Y4UU1ORzRXWUNRWDlCUDJCOEU3QjZLRw=='
var axios = require("axios");

var config = {
  method: "get",
  url: "{API_URL}/api/v1/content/bundles",
  headers: {
    Authorization:
      "Basic RDZXN1Y4US1NTkc0V1lDLVFYOUJQMkItOEU3QjZLRzpUNFNHSjlISDQ3TVpRWkdTWkVGVjZYUk5TS1E4RDZXN1Y4UU1ORzRXWUNRWDlCUDJCOEU3QjZLRw==",
  },
};

axios(config)
  .then(function (response) {
    console.log(JSON.stringify(response.data));
  })
  .catch(function (error) {
    console.log(error);
  });

The above command returns JSON structured like this:

{
  "content": [
    {
      "title": "Client Content Bundle Edit 2",
      "contentId": "Client Content Bundle 2",
      "bundleContentIds": ["Content Id 4", "Content Id 5"],
      "price": 10,
      "currency": "INR",
      "duration": 2,
      "tags": ["tag7"],
      "url": "https://www.yoursite.com/yourcontent",
      "contentType": "STORY",
      "priceOverrides": {
        "country": [
          {
            "_id": "605b25824646e9233aef61b4",
            "name": "GL",
            "price": 2
          }
        ]
      }
    },
    {
      "title": "Test content bundle for API functionality",
      "bundleContentIds": ["Content Id 1", "Content Id 2", "Content Id 3"],
      "contentId": "Client Content Bundle 1",
      "price": 15,
      "currency": "INR",
      "duration": 30,
      "url": "https://www.yoursite.com/yourcontent",
      "contentType": "STORY"
    }
  ],
  "pagination": {
    "pageNumber": 1,
    "pageSize": 20,
    "totalRecords": 2,
    "totalPages": 1
  }
}

This endpoint allows the Client to view their entire collection of Registered Content Bundles on ConsCent. With each retrieved content bundle containing the following details - bundleContentIds, Title, Price, URL, Content ID and duration.

HTTP Request

GET {API_URL}/api/v1/content/bundles

Authorization

Client API Key and Secret must be passed in Authorization Headers using Basic Auth. With API Key as the Username and API Secret as the password.

URL Parameters

Parameter Default Description
pageNumber optional Pagination Parameters - which page of the content bundles list you would like to retrieve (default = 1). Since each page will have 20 (default) individual contents ONLY.
pageSize optional Pagination Parameters - the number of individual content bundles to retrieve on each page (default = 20).

Donations

Create Donation


<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => '{API_URL}/api/v1/donation/',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS =>'{
    "content": {
        "id": "7943789",
        "title": "donation",
        "url": "https://www.testurl.com"
    },
    "receiver": {
        "name": "testname",
        "id": "537526324",
        "pitchMessage": "msg 1",
        "thankyouMessage": "msg 2",
        "avatarUrl": "https://www.avturl.com",
        "posts": "35",
        "views": "74784"
    },
    "clientId": "601a8ea4f2149f64hrt64ybh",
    "deepLink": "deeplinkforappredredirect"
}',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

curl --location --request POST '{API_URL}/api/v1/donation/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "content": {
        "id": "7943789",
        "title": "donation",
        "url": "https://www.testurl.com"
    },
    "receiver": {
        "name": "testname",
        "id": "537526324",
        "pitchMessage": "msg 1",
        "thankyouMessage": "msg 2",
        "avatarUrl": "https://www.avturl.com",
        "posts": "35",
        "views": "74784"
    },
    "clientId": "601a8ea4f2149f75h4hd678j",
    "deepLink": "deeplinkforappredredirect"
}'
var axios = require("axios");
var data = JSON.stringify({
  content: { id: "7943789", title: "donation", url: "https://www.testurl.com" },
  receiver: {
    name: "testname",
    id: "537526324",
    pitchMessage: "msg 1",
    thankyouMessage: "msg 2",
    avatarUrl: "https://www.avturl.com",
    posts: "35",
    views: "74784",
  },
  clientId: "601a8ea4f2149f5jhf83hfyt",
  deepLink: "deeplinkforappredredirect",
});

var config = {
  method: "post",
  url: "{API_URL}/api/v1/donation/",
  headers: {
    "Content-Type": "application/json",
  },
  data: data,
};

axios(config)
  .then(function (response) {
    console.log(JSON.stringify(response.data));
  })
  .catch(function (error) {
    console.log(error);
  });

The above command returns JSON structured like this:

{
  "message": "Donation created successfully",
  "donation": {
    "status": "INITIATED",
    "_id": "612f10d26bdd7b7a82eeaf68",
    "deepLink": "deeplinkforappredredirect",
    "content": {
      "id": "7943789",
      "title": "donation",
      "url": "https://www.testurl.com"
    },
    "receiver": {
      "name": "testname",
      "id": "537526324",
      "pitchMessage": "msg 1",
      "thankyouMessage": "msg 2",
      "avatarUrl": "https://www.avturl.com",
      "posts": "35",
      "views": "74784"
    },
    "clientId": "601a8ea4f2149f5jhf83hfyt",
    "createdAt": "2021-09-01T05:34:10.688Z",
    "updatedAt": "2021-09-01T05:34:10.688Z",
    "__v": 0
  }
}

This endpoint allows you to create a donation in the 'INITIATED' state - with the receiver details (id, name, pitchMessage, thankyouMessage, avatarUrl, posts count and view count), the content details (id, title, url) and the associated ConsCent clientId of your platform. The successfully created donation provides you with a '_id' field in the donation object of the response, which is the unique donation ID and must be passed to ConsCent to implement the donation flow.

HTTP Request

POST {API_URL}/api/v1/donation

Request Body

Parameter Default Description
clientId required your platforms ConsCent client ID - which can be found on the ConsCent client dashboard, in the SDK integration section.
receiver.name required Name of the individual that created the content and will be receiving the donation
receiver.avatarUrl required Url for an image/gif which the receiver chooses to be shown on the first donation screen
receiver.id optional ID of the receiver
receiver.pitchMessage optional Message chosen by the receiver to be shown on the first donation screen
receiver.thankyouMessage optional Message chosen by the receiver to be shown to the user on making a successfull donation
receiver.posts optional The count of posts that the receiver has contributed to the platform
receiver.views optional The number of views that have occured on the particular content;
content.id optional ID of the associated content
content.title optional Title of the associated content
content.url optional URL of the associated content - where the content will be available
deepLink optional Deep Link for redirecting back to the app after donation flow is completed - on iOS/Android

Get Client Donations

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => '{API_URL}/api/v1/client/donations?from=2021-07-02T05:45:41.389Z',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'Authorization: Basic TVZaVEZKOS1CNTlNNE5LLUczTUMyMDYtTUVFVktDMjozUzNFUkYwWjlBTTFNRkpYNTJDUTRKTUdWSlpNTVZaVEZKOUI1OU00TktHM01DMjA2TUVFVktDMg=='
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
curl --location --request GET '{API_URL}/api/v1/client/donations?from=2021-07-02T05:45:41.389Z' \
--header 'Authorization: Basic TVZaVEZKOS1CNTlNNE5LLUczTUMyMDYtTUVFVktDMjozUzNFUkYwWjlBTTFNRkpYNTJDUTRKTUdWSlpNTVZaVEZKOUI1OU00TktHM01DMjA2TUVFVktDMg=='
var axios = require("axios");

var config = {
  method: "get",
  url: "{API_URL}/api/v1/client/donations?from=2021-07-02T05:45:41.389Z",
  headers: {
    Authorization:
      "Basic TVZaVEZKOS1CNTlNNE5LLUczTUMyMDYtTUVFVktDMjozUzNFUkYwWjlBTTFNRkpYNTJDUTRKTUdWSlpNTVZaVEZKOUI1OU00TktHM01DMjA2TUVFVktDMg==",
  },
};

axios(config)
  .then(function (response) {
    console.log(JSON.stringify(response.data));
  })
  .catch(function (error) {
    console.log(error);
  });

The above command returns JSON structured like this:

{
  "itemizedDonations": [
    {
      "_id": "612ccd403ef4d528dd03bf79",
      "clientId": {
        "name": "Test Client"
      },
      "createdAt": "2021-08-30T12:21:20.610Z",
      "amount": 11,
      "priceDetails": {
        "amount": 11,
        "currency": "INR"
      },
      "userAccount": {
        "phoneNumber": "9999999999"
      }
    },
    {
      "_id": "612ccbd83ef4d528dd03bf77",
      "clientId": {
        "name": "Test Client"
      },
      "createdAt": "2021-08-30T12:15:20.277Z",
      "amount": 21,
      "priceDetails": {
        "amount": 21,
        "currency": "INR"
      },
      "userAccount": {
        "phoneNumber": "9999999999"
      }
    }
  ],
  "totalDonations": {
    "totalSpend": 32,
    "count": 2
  }
}

This endpoint allows you to fetch all the donations made by users on the clients platform, with the 'itemizedDonations' array containing the details of each individual donation and the 'totalDonations' object giving the aggregated data for the donations (total count & amount) for the defined time period.

HTTP Request

POST {API_URL}/api/v1/client/donations

Authorization

Client API Key and Secret must be passed in Authorization Headers using Basic Auth. With API Key as the Username and API Secret as the password.

URL Parameters

Parameter Default Description
from optional The date after (and including) which all donations that are made should be returned (default is 1 month ago from current Date/Time)
to optional The date before which all donations that are made should be returned (default is current Date/Time)
receiverName optional Filter the donations by a particular receiver (name)
contentTitle optional Filter the donations by a particular content (title)

Validate Content Consumption

Validate Content Details By Consumption ID

Replace the {consumptionId} in the API path with the actual value/string of the consumptionId recieved

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "{API_URL}/api/v1/content/consumption/11c369df-2a30-4a0d-90dc-5a45797dacdd",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
curl -X POST '{API_URL}/api/v1/content/consumption/{consumptionId}'
var axios = require("axios");

var config = {
  method: "post",
  url: "{API_URL}/api/v1/content/consumption/{consumptionId}",
  headers: {},
};

axios(config)
  .then(function (response) {
    console.log(JSON.stringify(response.data));
  })
  .catch(function (error) {
    console.log(error);
  });

The above command returns JSON structured like this:

[
  {
    "message": "Content Consumption Confirmed",
    "payload": {
      "clientId": "5fbb40b07dd98b0e89d90a25",
      "contentId": "Client Content Id",
      "createdAt": "2020-11-15T13:55:36.659Z"
    },
    "consumptionId": "11c369df-2a30-4a0d-90dc-5a45797dacdd",
    "signature": "4379hrm47mo34m2340cny2rcn487cn209842cr474107nc409c4"
  }
]

This endpoint allows the Client to Validate the Content Details anytime a User Purchases any Content of the Client using ConsCent - with the Client passing the Content ID in the request and recieving details regarding the Content Id and the Date of Purchase of the Content by the User, as well as matching the unique Consumption Id to ensure it cannot be reused.

HTTP Request

POST {API_URL}/api/v1/content/consumption/{consumptionId}

The client will recieve a payload when any content is purchased via ConsCent - providing the details of the content such as the ClientId to identify which client the content belongs to as well as the Client Content ID, Transaction Amount and Date of the Transaction. Moroever, they will also recieve a Consumption ID - by passing the Consumption ID in this API request - the Client can verify the authenticity of the transaction and restrict any spillage.

URL Parameters

Parameter Default Description
consumptionId required consumptionId recieved by the client for each unique transaction on any of the Client's Content registered with ConsCent

Client Stats

Specific Content Stats


<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => '{API_URL}/api/v1/client/stats/content/your-content-id?from=2021-02-12T05:45:41.389Z&to=2021-02-13T05:45:41.389Z',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'Authorization: Basic WTE3UkdRSy1RMlQ0UEo5LU4zWVNSWEotRFNSNERZTTpQUkVTVDdTRTZSTUNXWVBaNjRZQzdXUlA2UEpEWTE3UkdRS1EyVDRQSjlOM1lTUlhKRFNSNERZTQ=='
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;



curl -X GET '{API_URL}/api/v1/client/stats/content/your-content-id?from=2021-02-12T05:45:41.389Z&to=2021-02-13T05:45:41.389Z' \
-H 'Authorization: Basic WTE3UkdRSy1RMlQ0UEo5LU4zWVNSWEotRFNSNERZTTpQUkVTVDdTRTZSTUNXWVBaNjRZQzdXUlA2UEpEWTE3UkdRS1EyVDRQSjlOM1lTUlhKRFNSNERZTQ=='

var axios = require("axios");

var config = {
  method: "get",
  url: "{API_URL}/api/v1/client/stats/content/your-content-id?from=2021-02-12T05:45:41.389Z&to=2021-02-13T05:45:41.389Z",
  headers: {
    Authorization:
      "Basic WTE3UkdRSy1RMlQ0UEo5LU4zWVNSWEotRFNSNERZTTpQUkVTVDdTRTZSTUNXWVBaNjRZQzdXUlA2UEpEWTE3UkdRS1EyVDRQSjlOM1lTUlhKRFNSNERZTQ==",
  },
};

axios(config)
  .then(function (response) {
    console.log(JSON.stringify(response.data));
  })
  .catch(function (error) {
    console.log(error);
  });

The above command returns JSON structured like this:

{
  "count": 53,
  "amount": 588.74,
  "currency": "INR"
}

This endpoint allows our partners to get purchase count and purchase amount for a particular content id. Please pass the date-range as ISO-date strings in the from and to query parameters. Also pass the content id as a path parameter. By default this API provides details of all time consumption.

HTTP Request

POST {API_URL}/api/v1/client/stats/content/:replace-with-contentid

Authorization

Client API Key and Secret must be passed in Authorization Headers using Basic Auth. With API Key as the Username and API Secret as the password.

Query Parameters

Parameter Default Description
from optional ISO date string from which the aggregated stats have to be calculated
to optional ISO date string till which the aggregated stats have to be calculated

Daily Content Stats


<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => '{API_URL}/api/v1/client/stats/daily?from=2021-02-12T05:45:41.389Z&to=2021-02-13T05:45:41.389Z',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'Authorization: Basic WTE3UkdRSy1RMlQ0UEo5LU4zWVNSWEotRFNSNERZTTpQUkVTVDdTRTZSTUNXWVBaNjRZQzdXUlA2UEpEWTE3UkdRS1EyVDRQSjlOM1lTUlhKRFNSNERZTQ=='
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;



curl -X GET '{API_URL}/api/v1/client/stats/daily?from=2021-02-12T05:45:41.389Z&to=2021-02-13T05:45:41.389Z' \
-H 'Authorization: Basic WTE3UkdRSy1RMlQ0UEo5LU4zWVNSWEotRFNSNERZTTpQUkVTVDdTRTZSTUNXWVBaNjRZQzdXUlA2UEpEWTE3UkdRS1EyVDRQSjlOM1lTUlhKRFNSNERZTQ=='

var axios = require("axios");

var config = {
  method: "get",
  url: "{API_URL}/api/v1/client/stats/daily?from=2021-02-12T05:45:41.389Z&to=2021-02-13T05:45:41.389Z",
  headers: {
    Authorization:
      "Basic WTE3UkdRSy1RMlQ0UEo5LU4zWVNSWEotRFNSNERZTTpQUkVTVDdTRTZSTUNXWVBaNjRZQzdXUlA2UEpEWTE3UkdRS1EyVDRQSjlOM1lTUlhKRFNSNERZTQ==",
  },
};

axios(config)
  .then(function (response) {
    console.log(JSON.stringify(response.data));
  })
  .catch(function (error) {
    console.log(error);
  });

The above command returns JSON structured like this:

{
  "totalContentConsumed": 17,
  "totalRevenueGenerated": 29.6
}

This endpoint allows the Client to get Aggregate Statistics based on users consumption of their content via ConsCent. By default this API provides details of the previous days' consumption. However, the client can pass the 'from' and 'to' dates as optional query parameters to get aggregated stats for any range that they choose. The value of 'totalRevenueGenerated' in the response if given in "INR" by default.

HTTP Request

POST {API_URL}/api/v1/client/stats/daily

Authorization

Client API Key and Secret must be passed in Authorization Headers using Basic Auth. With API Key as the Username and API Secret as the password.

Query Parameters

Parameter Default Description
from optional ISO date string from which the aggregated stats have to be calculated
to optional ISO date string till which the aggregated stats have to be calculated

Current Subscriber Stats


<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => '{API_URL}/api/v1/subscription/client/list',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'Authorization: Basic TVZaVEZKOS1CNTlNNE5LLUczTUMyMDYtTUVFVktDMjozUzNFUkYwWjlBTTFNRkpYNTJDUTRKTUdWSlpNTVZaVEZKOUI1OU00TktHM01DMjA2TUVFVktDMg=='
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;



curl --location --request GET '{API_URL}/api/v1/subscription/client/list' \
--header 'Authorization: Basic TVZaVEZKOS1CNTlNNE5LLUczTUMyMDYtTUVFVktDMjozUzNFUkYwWjlBTTFNRkpYNTJDUTRKTUdWSlpNTVZaVEZKOUI1OU00TktHM01DMjA2TUVFVktDMg=='

var axios = require("axios");

var config = {
  method: "get",
  url: "{API_URL}/api/v1/subscription/client/list",
  headers: {
    Authorization:
      "Basic TVZaVEZKOS1CNTlNNE5LLUczTUMyMDYtTUVFVktDMjozUzNFUkYwWjlBTTFNRkpYNTJDUTRKTUdWSlpNTVZaVEZKOUI1OU00TktHM01DMjA2TUVFVktDMg==",
  },
};

axios(config)
  .then(function (response) {
    console.log(JSON.stringify(response.data));
  })
  .catch(function (error) {
    console.log(error);
  });

The above command returns JSON structured like this:

{
    "subscriptions": [
        {
            "renewSubscription": false,
            "freeTrial": false,
            "_id": "617a78b780033b289c552298",
            "userAccount": {
                "address": {
                    "apartment": "4792",
                    "area": "Chattarpur",
                    "pincode": "110074",
                    "landmark": "ifelneddckjlj",
                    "city": "New Delhi",
                    "state": "Delhi",
                    "country": "IN"
                },
                "name": "Test Name",
                "phoneNumber": "9847473843",
                "email": "usertesting@email.com"
            },
            "buyingPrice": 96.5,
            "price": 100,
            "country": "IN",
            "city": "bengaluru (nagashettyhalli)",
            "expiryDate": "2022-01-28T10:17:27.354Z",
            "priceDetails": {
                "price": 100,
                "currency": "INR"
            },
            "subscriptionTitle": "Subscription 2",
            "operatingSystem": "Mac OS",
            "device": "desktop",
            "subscriptionType": {
                "physical": false,
                "digital": true
            },
            "createdAt": "2021-10-28T10:17:27.359Z"
        }
    ]

This endpoint allows the Client to get the list of all currently active subscriptions via ConsCent. Including the details of each subscription purchased, such as the title, price, the amount and currency paid by the user, the type of subscription, date of purchase, date of expiry, renewal and free trial booleans, as well as the user details - phone number, email, addressm , OS, device and location.

HTTP Request

POST {API_URL}/api/v1/subscription/client/list

Authorization

Client API Key and Secret must be passed in Authorization Headers using Basic Auth. With API Key as the Username and API Secret as the password.

Client Subscriptions

Migrate User and Purchased Subscription


<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'http://localhost:3001/api/v1/subscription/migrate',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS =>'{
    "userPrimaryEmail": "testemail@test.com",
    "userPrimaryPhone": "9545734678",
    "userSecondaryEmail": "testemailsecond@test.com",
    "userSecondaryPhone": "9545732228",
    "userName": "testUser",
    "expiryDate": "2022-01-25T12:39:28.337Z",
    "purchaseDate": "2022-01-25T12:39:28.337Z",
    "country": "IN",
    "clientUserId": "9342793972792",
    "userAddress": {
        "address": "test address line 1",
        "city": "New Delhi",
        "state": "DELHI",
        "postcode": "110001"
    },
    "utmParameters": {
        "utm_source": "website",
        "utm_medium": "facebook"
    },
    "subscriptionDetails": {
        "title": "Migrated Subscription 1",
        "priceDetails": {
            "price": 200,
            "currency": "INR"
        },
        "subscriptionType": {
            "physical": false,
            "digital": true
        },
        "internalSubscriptionId": "89432923924792792379"
    }
}',
  CURLOPT_HTTPHEADER => array(
    'Authorization: Basic TVZaVEZKOS1CNTlNNE5LLUczTUMyMDYtTUVFVktDMjozUzNFUkYwWjlBTTF7942mx974727929TUdWSlpNTVZaVEZKOUI1OU00TktHM01DMjA2TUVFVktDMg==',
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;


curl -X POST 'http://localhost:3001/api/v1/subscription/migrate' \
--header 'Authorization: Basic TVZaVEZKOS1CNTlNNE5LLUczTUMyMDYtTUVFVktDMjozUzNFU73474977942792SlpNTVZaVEZKOUI1OU00TktHM01DMjA2TUVFVktDMg==' \
--header 'Content-Type: application/json' \
--data-raw '{
    "userPrimaryEmail": "testemail@test.com",
    "userPrimaryPhone": "9545734678",
    "userSecondaryEmail": "testemailsecond@test.com",
    "userSecondaryPhone": "9545732228",
    "userName": "testUser",
    "expiryDate": "2022-01-25T12:39:28.337Z",
    "purchaseDate": "2022-01-25T12:39:28.337Z",
    "country": "IN",
    "clientUserId": "9342793972792",
    "userAddress": {
        "address": "test address line 1",
        "city": "New Delhi",
        "state": "DELHI",
        "postcode": "110001"
    },
    "utmParameters": {
        "utm_source": "website",
        "utm_medium": "facebook"
    },
    "subscriptionDetails": {
        "title": "Migrated Subscription 1",
        "priceDetails": {
            "price": 200,
            "currency": "INR"
        },
        "subscriptionType": {
            "physical": false,
            "digital": true
        },
        "internalSubscriptionId": "89432923924792792379"
    }
}'
var axios = require("axios");
var data = JSON.stringify({
  userPrimaryEmail: "testemail@test.com",
  userPrimaryPhone: "9545734678",
  userSecondaryEmail: "testemailsecond@test.com",
  userSecondaryPhone: "9545732228",
  userName: "testUser",
  expiryDate: "2022-01-25T12:39:28.337Z",
  purchaseDate: "2022-01-25T12:39:28.337Z",
  country: "IN",
  clientUserId: "9342793972792",
  userAddress: {
    address: "test address line 1",
    city: "New Delhi",
    state: "DELHI",
    postcode: "110001",
  },
  utmParameters: { utm_source: "website", utm_medium: "facebook" },
  subscriptionDetails: {
    title: "Migrated Subscription 1",
    priceDetails: { price: 200, currency: "INR" },
    subscriptionType: { physical: false, digital: true },
    internalSubscriptionId: "89432923924792792379",
  },
});

var config = {
  method: "post",
  url: "http://localhost:3001/api/v1/subscription/migrate",
  headers: {
    Authorization:
      "Basic TVZaVEZKOS1CNTlNNE5LLUczTUMyMDYtTUVFVktDMjozUzNFUkYwWj7479m2x7924792x297TVZaVEZKOUI1OU00TktHM01DMjA2TUVFVktDMg==",
    "Content-Type": "application/json",
  },
  data: data,
};

axios(config)
  .then(function (response) {
    console.log(JSON.stringify(response.data));
  })
  .catch(function (error) {
    console.log(error);
  });

The above command returns JSON structured like this:

{
  "message": "Subscription migrated successfully",
  "migratedSubscription": {
    "gstComponents": {
      "physical": 0,
      "digital": 0
    },
    "inrGstComponents": {
      "physical": 0,
      "digital": 0
    },
    "migratedSubscriptionDetails": {
      "priceDetails": {
        "price": 200,
        "currency": "INR"
      },
      "subscriptionType": {
        "physical": false,
        "digital": true
      },
      "title": "Migrated Subscription 1",
      "internalSubscriptionId": "89432923924792792379"
    },
    "manuallyRenewed": false,
    "renewSubscription": false,
    "availedOffers": [],
    "promotional": false,
    "tags": [],
    "bundle": false,
    "bundleContentIds": [],
    "paymentType": [],
    "freeTrial": false,
    "migrated": true,
    "_id": "61f25e0a9d50b5d6b90479eb",
    "clientId": "601a8ea4f2149f089782814f",
    "userAccount": "61f25e0a9d50b5d6b90479e8",
    "price": 0,
    "buyingPrice": 0,
    "priceDetails": {
      "price": 0,
      "currency": "INR"
    },
    "type": "SUBSCRIPTION",
    "subscriptionTitle": "Migrated Subscription 1",
    "subscriptionType": {
      "physical": false,
      "digital": true
    },
    "subscriptionId": "61eff7907acd46480c5259d8",
    "createdAt": "2022-01-27T08:55:38.786Z",
    "migratedCreatedAt": "2022-01-25T12:39:28.337Z",
    "expiryDate": "2022-01-25T12:39:28.337Z",
    "country": "IN",
    "userCountry": "IN",
    "utmParameters": {
      "utm_source": "website",
      "utm_medium": "facebook"
    },
    "updatedAt": "2022-01-27T08:55:38.786Z",
    "__v": 0
  }
}

This endpoint allows the Client to migrate a user's subscription to ConsCent, including the details of the user, subscription and the purchase on their platform - with the userPhoneNumber, userEmail, userName, clientUserId, expiryDate, purchaseDate. utmParameters, userAddress (address, city, state, postcode), country, and other client specific subscriptionDetails - title, priceDetails (price & currency), subscriptionType (digital & physical), and internalSubscriptionId. It is required to pass either the 'userPrimaryEmail' or the 'userPrimaryPhone' - as the primary login of the user on ConsCent.

HTTP Request

POST {API_URL}/api/v1/subscription/migrate

Authorization

Client API Key and Secret must be passed in Authorization Headers using Basic Auth. With API Key as the Username and API Secret as the password.

Request Body

Parameter Default Description
userPrimaryEmail optional The email of the user for whom the purchased subscription is being migrated (used as primary login method)
userPrimaryPhone optional The phone number of the user for whom the purchased subscription is being migrated provided. (used as primary login method is no primary email is provided)
userSecondaryEmail optional The alternate email of the user for whom the purchased subscription is being migrated (not used for login and provided in webhooks/data exports for the client)
userSecondaryPhone optional The phone number of the user for whom the purchased subscription is being migrated provided. (not used for login and provided in webhooks/data exports for the client)
expiryDate required Array of ContentIds - The date on which the migrated subscription will expire for the user (must be an ISO Date String)
purchaseDate required The Date on which the user purchased the subscription on the client's platform (must be an ISO Date String)
country required The country of the user that purchased the subscription (must be an ISO Alpha-2 code from the list provided below)
userName optional The name of the user for whom the purchased subscription is being migrated
clientUserId optional The userID of the associated user in the client's platform - will be returned in relevant webhooks to the client for matching the details/purchases of the user accurately;
userAddress optional REQUIRED for a physical subscription - address of the user for whom the purchased subscription is being migrated - must be passed as an object containing the fields - address, city, state, postcode.
subscriptionDetails required Details of the subscription being migrated. Must be passed as an object containing the fields - title, priceDetails: {price: number, currency: string}, subscriptionType: {physical: boolean, digital: boolean}, internalSubscriptionId - where the subscriptionType is a required field, and must be passed; while all other fields are optional.
utmParameters optional The UTM parameters associated with the subscription being migrated. Must be passed as an object containing the fields - utm_source & utm_source - both of which are optional

Deprecated Integration Documentation

To view the deprecated integration documentation containing the Story APIs - Click here.

Please not that we no longer provide support for this documentation and it will be removed soon. We urge you to make use of the updated integration documentation. You can email us at support@conscent.in for any queries that you might have.

Country Code List

Afghanistan - AF

Åland Islands - AX

Albania - AL

Algeria - DZ

American Samoa - AS

Andorra - AD

Angola - AO

Anguilla - AI

Antarctica - AQ

Antigua and Barbuda - AG

Argentina - AR

Armenia - AM

Aruba - AW

Australia - AU

Austria - AT

Azerbaijan - AZ

Bahrain - BH

Bahamas - BS

Bangladesh - BD

Barbados - BB

Belarus - BY

Belgium - BE

Belize - BZ

Benin - BJ

Bermuda - BM

Bhutan - BT

Bolivia, Plurinational State of - BO

Bonaire, Sint Eustatius and Saba - BQ

Bosnia and Herzegovina - BA

Botswana - BW

Bouvet Island - BV

Brazil - BR

British Indian Ocean Territory - IO

Brunei Darussalam - BN

Bulgaria - BG

Burkina Faso - BF

Burundi - BI

Cambodia - KH

Cameroon - CM

Canada - CA

Cape Verde - CV

Cayman Islands - KY

Central African Republic - CF

Chad - TD

Chile - CL

China - CN

Christmas Island - CX

Cocos (Keeling) Islands - CC

Colombia - CO

Comoros - KM

Congo - CG

Congo, the Democratic Republic of the - CD

Cook Islands - CK

Costa Rica - CR

Côte d'Ivoire - CI

Croatia - HR

Cuba - CU

Curaçao - CW

Cyprus - CY

Czech Republic - CZ

Denmark - DK

Djibouti - DJ

Dominica - DM

Dominican Republic - DO

Ecuador - EC

Egypt - EG

El Salvador - SV

Equatorial Guinea - GQ

Eritrea - ER

Estonia - EE

Ethiopia - ET

Falkland Islands (Malvinas) - FK

Faroe Islands - FO

Fiji - FJ

Finland - FI

France - FR

French Guiana - GF

French Polynesia - PF

French Southern Territories - TF

Gabon - GA

Gambia - GM

Georgia - GE

Germany - DE

Ghana - GH

Gibraltar - GI

Greece - GR

Greenland - GL

Grenada - GD

Guadeloupe - GP

Guam - GU

Guatemala - GT

Guernsey - GG

Guinea - GN

Guinea-Bissau - GW

Guyana - GY

Haiti - HT

Heard Island and McDonald Islands - HM

Holy See (Vatican City State) - VA

Honduras - HN

Hong Kong - HK

Hungary - HU

Iceland - IS

India - IN

Indonesia - ID

Iran, Islamic Republic of - IR

Iraq - IQ

Ireland - IE

Isle of Man - IM

Israel - IL

Italy - IT

Jamaica - JM

Japan - JP

Jersey - JE

Jordan - JO

Kazakhstan - KZ

Kenya - KE

Kiribati - KI

Korea, Democratic People's Republic of - KP

Korea, Republic of - KR

Kuwait - KW

Kyrgyzstan - KG

Lao People's Democratic Republic - LA

Latvia - LV

Lebanon - LB

Lesotho - LS

Liberia - LR

Libya - LY

Liechtenstein - LI

Lithuania - LT

Luxembourg - LU

Macao - MO

Macedonia, the Former Yugoslav Republic of - MK

Madagascar - MG

Malawi - MW

Malaysia - MY

Maldives - MV

Mali - ML

Malta - MT

Marshall Islands - MH

Martinique - MQ

Mauritania - MR

Mauritius - MU

Mayotte - YT

Mexico - MX

Micronesia, Federated States of - FM

Moldova, Republic of - MD

Monaco - MC

Mongolia - MN

Montenegro - ME

Montserrat - MS

Morocco - MA

Mozambique - MZ

Myanmar - MM

Namibia - NA

Nauru - NR

Nepal - NP

Netherlands - NL

New Caledonia - NC

New Zealand - NZ

Nicaragua - NI

Niger - NE

Nigeria - NG

Niue - NU

Norfolk Island - NF

Northern Mariana Islands - MP

Norway - NO

Oman - OM

Pakistan - PK

Palau - PW

Palestine, State of - PS

Panama - PA

Papua New Guinea - PG

Paraguay - PY

Peru - PE

Philippines - PH

Pitcairn - PN

Poland - PL

Portugal - PT

Puerto Rico - PR

Qatar - QA

Réunion - RE

Romania - RO

Russian Federation - RU

Rwanda - RW

Saint Barthélemy - BL

Saint Helena, Ascension and Tristan da Cunha - SH

Saint Kitts and Nevis - KN

Saint Lucia - LC

Saint Martin (French part) - MF

Saint Pierre and Miquelon - PM

Saint Vincent and the Grenadines - VC

Samoa - WS

San Marino - SM

Sao Tome and Principe - ST

Saudi Arabia - SA

Senegal - SN

Serbia - RS

Seychelles - SC

Sierra Leone - SL

Singapore - SG

Sint Maarten (Dutch part) - SX

Slovakia - SK

Slovenia - SI

Solomon Islands - SB

Somalia - SO

South Africa - ZA

South Georgia and the South Sandwich Islands - GS

South Sudan - SS

Spain - ES

Sri Lanka - LK

Sudan - SD

Suriname - SR

Svalbard and Jan Mayen - SJ

Swaziland - SZ

Sweden - SE

Switzerland - CH

Syrian Arab Republic - SY

Taiwan, Province of China - TW

Tajikistan - TJ

Tanzania, United Republic of - TZ

Thailand - TH

Timor-Leste - TL

Togo - TG

Tokelau - TK

Tonga - TO

Trinidad and Tobago - TT

Tunisia - TN

Turkey - TR

Turkmenistan - TM

Turks and Caicos Islands - TC

Tuvalu - TV

Uganda - UG

Ukraine - UA

United Arab Emirates - AE

United Kingdom - GB

United States - US

United States Minor Outlying Islands - UM

Uruguay - UY

Uzbekistan - UZ

Vanuatu - VU

Venezuela, Bolivarian Republic of - VE

Viet Nam - VN

Virgin Islands, British - VG

Virgin Islands, U.S. - VI

Wallis and Futuna - WF

Western Sahara - EH

Yemen - YE

Zambia - ZM

Zimbabwe - ZW

Errors

The ConsCent API uses the following error codes:

Error Code Meaning
400 Bad Request -- Your request is invalid.
401 Unauthorized -- Invalid API Key & API Secret.
403 Forbidden -- The resource requested is hidden for administrators only.
404 Not Found -- The resource requested could not be found.
405 Method Not Allowed -- You tried to access a resource with an invalid method.
406 Not Acceptable -- You requested a format that isn't json.
410 Gone -- The resource has been removed from our servers.
418 I'm a teapot.
429 Too Many Requests -- You're requesting too many resources! Slow down!
500 Internal Server Error -- We had a problem with our server. Try again later.
503 Service Unavailable -- We're temporarily offline for maintenance. Please try again later.