How To Use The Purk Button API
Introduction
Purk was created to help content owners and service providers monetise their website or application by accepting quick and easy micropayments from their users or customers. Website users can send Purk to a content owner or service provider to show appreciation for their hard work.
By sending micropayments as a donation, it highly reduces the amount of monetisation that is needed on a website. Instead of using intrusive adverts, affiliate links, pop ups and sponsored posts, website owners can install the Purk Button and accept quick and easy payments to monetise their content or service instead. Not only does this reduce the amount of promotional clutter on a website, it also reduces costs on content writing and saves time by allowing your customers to tip/pay your writers or employees directly.
The Purk Button API was released in Beta on May 25, 2018.
Installation Instructions
Download Purk v1.0.2 from Github: https://github.com/purkproject/purk/releases
Once Purk is installed, visit the “Purk API” page in the GUI wallet and generate a Purk Button for your website.
Ensure to include the full base URL of your website including http:// or https:// and select either a small, medium or large button as you see fit.
You will be provided with an iframe embed code which you need to add to your websites source code similar to below:
<iframe style="width: 100px;height: 30px;border: 0;" src="https://api.purkproject.com/api/?apikey=b843c5e8-bbe5-4a31-a8ff-5034ca0bdd91"></iframe>
Once you have embedded the iframe on your website you will be able to start accepting donations in PURK.
Using The Purk Button
It’s very simple to make a donation on a website that has the Purk Button installed:
- Make sure you have your GUI wallet open.
- Click the Purk Button on the website where it is embedded.
- Select how much PURK you want to send to the content owner in the pop up modal.
- Click the submit button.
- The modal will show “Payment pending” while it waits for your confirmation.
- Confirm your payment in the dialog in the GUI wallet
You just sent PURK as a donation to a content owner!
Use Cases
The Purk Button API can be used for a number or online activities including:
- Blogging and multi-blogging platforms
- Tips or gratuities for a service
- Charities / nonprofit
- Donation based activities
- Fundraising
- Development funds
- Personal donations
- Incentive based projects
FAQ
Q: Can I use multiple button embed codes on one website.
A: Yes! If you want to track certain campaigns you can enter a specific URL in the GUI wallet for one or many pages.
Q: Can I use the Purk Button on websites that I don’t own.
A: Yes! But you will need to check the websites TOS and whether they allow iframe embeds.
Q: What does the Purk Button API record in the database?
A: Currently the API tracks the URL, wallet ID, how many donations have been made and the date the button was created.
Q: What type of websites can I embed the Purk Button on?
A: Anywhere you have access to the source code or that will accept iframe embeds. Although using the Purk Button for any illegal activities is strictly prohibited.
Q: When will you release the Purk Button API on Github
A: We held a vote on Discord and 75% of the community voted to release the Purk Button API once the network is more established and tested in a live environment.
Resources
Purk has a number of official online resources where you can find out more information about the cryptocurrency, technical details, future plans, news and announcements.
- Website: https://purkproject.com
- Github: https://github.com/purkproject/purk
- Documentation: https://docs.purkproject.com
- Block Explorer: https://explorer.purkproject.com
- Official Mining Pool: https://pool.purkproject.com
- Twitter: https://twitter.com/purkproject
- Discord: https://discord.gg/cqmSrfz
