How to register your content with the SatoshiPay API?

The API resource goods allows a merchant to manage their digital goods. A good in the API represents a merchant's digital good (e.g. news article, image, audio/video or file download) and holds all information needed for SatoshiPay to handle payments. This includes pricing information and other metadata, but not the content itself.

First you need to copy your SatoshiPay Account API Credentials.

Then download an API Development Environment (we recommend downloading Postman (https://www.getpostman.com/)

After installing Postman on your device, open Postman and you will see your "Workspace".

Let's get started!

STEPS:

(1) Create a Collection folder Name: SatoshiPay content

Add name: Register goods with SatoshiPay

and description: upload SatoshiPay content 

(2) Click on New and add a POST request

 

How to add a POST Request?

 

(1) Click on create request, add request name ("Register good with SatoshiPay") and save your request

 

 

 (2) In your workspace change it to a POST request (GET request is the default)

 

(3) Add your POST request details

 

Enter request URL: https://api.satoshipay.io/v2/goods

 

Authorization

Type: Basic Auth + past your API credentials from your SatoshiPay dashboard

 

 

Headers

Key: Content-Type

Value: application/json

 

 

 

Body

 

Properties required for POST request

 

Property	Type	Required	Description
price	integer	yes	Good's price in stroops. One lumen is 10^7 (10,000,000) stroops.
asset	string	yes	Asset of good's price. Only "XLM" is currently supported.
sharedSecret	string	yes	Shared secret information which will be used to sign the paymentReceipt used to authenticateuser during digital goods retrieval.
url	string	yes	URL of the web page which contains the good. Used as a reference in the Dashboard.
title	string	yes	Title of the good for reference in the provider dashboard.

 

{
 "sharedSecret": "abc",
 "price": 10000000,
 "asset": "XLM",
 "title": "your title",
 "url": "https://yoururl.com"
}

Example: 

(4) Click Send 

(5) Now your content is registered and you can see your registered content in your Publisher Dashboard . You also receive a unique good ID.

(6) Now you can add your unique goods ID to your HTML tag. See HTML text tag example below: 

<div class="satoshipay-placeholder"
    data-sp-type="text/html"
    data-sp-src="/paid-content/1.html"
    data-sp-id="558bcdbb1309c59725bdb559"
    data-sp-length="800"
></div>

Add this tag to your HTML Website code and find other HTML tags for images, audio, videos, download and donation here.