Awards (Credentials)
Build or integrate into your solution by using BWS Blockchain Badges API.
Awarding a badge represents the digital acknowledgment of an individual's skills, accomplishments, or milestones. This process enables the issuance of verifiable digital credentials to individuals who meet predefined criteria, serving as a modern and secure way to recognize professional development, achievements, or learning milestones.
An Open Badge award is a digital credential that adheres to the Open Badge standard, ensuring it includes essential metadata such as the badge name, description, issuing organization, criteria for earning, and the recipient's details. This verifiable and interoperable format allows the awarded badge to be shared across digital platforms, embedded in resumes or social profiles, and trusted as proof of achievement worldwide.
new_award
Use this operation to create a new award or credential, with the option to leverage blockchain technology for added transparency and trust.
By utilizing blockchain, each award is immutably recorded on a decentralized ledger, ensuring that the credential is tamper-proof and verifiable by anyone, anywhere. This not only enhances the credibility of the award but also provides long-term assurance to recipients and organizations that the achievement cannot be altered or disputed.
POST
https://api.bws.ninja/v1/call
Request Body
solution*
string
BWS.Blockchain.Badges
operation*
string
new_award
parameters*
JSON
new_award Method Parameters
We currently support Matchain blockchain network to certify BWS Blokchain Badge, as the most cost effective solution (1 badge award costs 0.01 USD).
badgeId
string
issuedOn
long
expires
long
recipient
JSON
blockchain
string
Optional. To enhance the security and verifiability specify the blockchain to use (e.g., "matchain"). Blockchain certification ensures your credentials are tamper-proof, globally verifiable, and maintain long-term trust and transparency.
new_award Recipient Parameters JSON
Include the below parameters to identify the certificate (award) recipient.
Recipient email data encryption.
When you send the recipient's email, we hash (encrypt) the original, and the readable email address is never saved into our databases.
string
The recipient email address.
name
string
The full name of the recipient.
new_award API Call Example
new_award Call Response
If everything goes ok, you get the awardId
, which is also the URL to access the Open Badge award definition.
list_awards
Use this operation to get a list of awards.
POST
https://api.bws.ninja/v1/call
Request Body
solution*
string
BWS.Blockchain.Badges
operation*
string
list_awards
parameters
JSON
optional parameters
list_awards Method Parameters
filter
JSON
The filtering options you want to apply.
lastEvaluatedKey
string
Use lastEvaluatedKey for pagination.
list_awards filter option Parameters
NOTE
If you use the filter keyword search option, a maximum of 51 awards will be returned, and no pagination will be available (lastEvaluatedKey).
badgeId*
string
The badge id you want to filter awards.
search
string
Award recipient search keyword (e.g., Robert). The system will search for any award recipient containing the search text.
list_awards API Call Example
To paginate and get new items, use the lastEvaluatedKey you got on the previous call.
list_awards Call Response
Once the API call is executed correctly, you will get a list of badge awards, and if more awards are available, lastEvaluatedKey parameter to use on next call.
send_award_email
Use this operation if you want BWS to email an award recipient, including a link to download, share, and visualize his achieved award.
POST
https://api.bws.ninja/v1/call
Request Body
solution*
string
BWS.Blockchain.Badges
operation*
string
send_award_email
parameters
JSON
send_award_email Method Parameters
awardId
string
The award ID
string
The award recipient's email address
send_award API Call Example
You need to know the award recipient's email address!
In full compliance with the General Data Protection Regulation (GDPR), our API is designed to be strongly committed to privacy and data protection. We understand the importance of safeguarding personal information and uphold the highest data privacy standards.
When our API processes email data, it does so in real time. The data is transmitted securely and never recorded, stored, or saved on our servers.
send_award_email Call Response
You will get a standard 200 response if the email is correctly sent.
Last updated
Was this helpful?