An issuer is an entity or organization responsible for defining, creating, and awarding digital badges to recognize and verify an individual's achievements, skills, or competencies.
Use this API operation to create a new Issuer that will be enabled to create digital badges and awards.
Use an email address you have access to!
To verify your permission to use the provided email, we will send a verification email (How to Verify a Badge Issuer).
When you create a new Badge Issuer, we send an email for verification, including a verification link and a verification code.
To verify an Issuer, you - or someone with access to the provided email inbox - should click on the verification link or send you the verification code (once you get the code, use the Verify Badge Issuer API call to verify the issuer).
A badge is a digital representation of an accomplishment, skill, or authorization that can be earned and displayed. It serves as verifiable proof of a user's achievements and can be shared across digital platforms.
new_badge
POSThttps://api.bws.ninja/v1/call
Use this operation to create a Badge you can later use to certify recognition.
Your badge image will be saved on the InterPlanetary File System (IPFS) and served from the BWS IPFS gateway service.
The images you use should be optimized to be consumed over the internet.
You must create your badge image to be less than 1 MB in size for fast access (there is a hard limit of 5MB).
constfs=require('fs');constaxios=require('axios');/* get the file representing the badge */constfileData=fs.readFileSync('./files/badge.png');/* encode file content to base64 */constencodedData=fileData.toString('base64');/* build request to use BWS Badges solution */constrequest= {{"solution": "BWS.Blockchain.Badges","operation": "new_badge","parameters": {"name":"Cloud Developer", "description": "Recognizes professionals who have demonstrated expertise in cloud computing, including development and management of cloud applications and services.",
"criteria": "To earn this badge, complete an accredited course in cloud computing, demonstrate practical experience with a portfolio of cloud projects, and pass an exam on cloud computing concepts, service models, and development practices.",
"image": encodedData }}/* call BWS API using Axios */let config = { method:'post', maxBodyLength:Infinity, url:'https://api.bws.ninja/v1/call', headers: { 'X-Api-Key':'XqaLg...... A5k2V729v',/* use your API key here! */'Content-Type':'application/json' }, data :JSON.stringify(request)};axios.request(config) .then((response) => {console.log(JSON.stringify(response.data)); }) .catch((error) => {console.log(error); });
Use this operation to get the list of issuer badges.
list_badges
POSThttps://api.bws.ninja/v1/call
Get the list of issuer badges.
Request Body
{"statusCode":200,"info": [ {"@context":"https://w3id.org/openbadges/v2","type":"BadgeClass","id":"https://badges.staging.bws.ninja/certify-badge/badge/a51233aa-f3a9-43ac-b784-a0e72ec93036","name":"BWS Blockchain Developer Associate", "description": "Recognizes professionals who have demonstrated expertise in blockchain, including development of applications using BWS cloud services.",
"image":"https://ipfs.bws.ninja/ipfs/QmXAkiFMsrMYQEiZE76oZ2hT4YEu97bvh8wdCnApvpFdeG","criteria": { "narrative": "To earn the Certified Blockchain Professional - BWS Cloud Services badge, candidates must complete an approved training course, demonstrate practical experience with BWS cloud services, submit a project, and pass a comprehensive written and practical exam."
},"issuer": {"id":"https://badges.staging.bws.ninja/certify-badge/issuer/d9623c7f-41ee-4481-86d4-974a322210b3","name":"Blockchain Web Services","url":"https://www.bws.ninja","email":"badges@bws.ninja","type":"Issuer","verified":true } } ]}
Once executed correctly, you will get a list of your badges, including the badge ID and the badge data.
{"statusCode":200,"info": [ {"@context":"https://w3id.org/openbadges/v2","type":"BadgeClass","id":"https://badges.staging.bws.ninja/certify-badge/badge/a51233aa-f3a9-43ac-b784-a0e72ec93036","name":"BWS Blockchain Developer Associate", "description": "Recognizes professionals who have demonstrated expertise in blockchain, including development of applications using BWS cloud services.",
"image":"https://ipfs.bws.ninja/ipfs/QmXAkiFMsrMYQEiZE76oZ2hT4YEu97bvh8wdCnApvpFdeG","criteria": { "narrative": "To earn the Certified Blockchain Professional - BWS Cloud Services badge, candidates must complete an approved training course, demonstrate practical experience with BWS cloud services, submit a project, and pass a comprehensive written and practical exam."
},"issuer": {"id":"https://badges.staging.bws.ninja/certify-badge/issuer/d9623c7f-41ee-4481-86d4-974a322210b3","name":"Blockchain Web Services","url":"https://www.bws.ninja","email":"badges@bws.ninja","type":"Issuer","verified":true } } ]}
Awarding a badge represents the digital acknowledgment of an individual's skills or achievements.
It enables the conferring of verifiable digital credentials to individuals who meet specific criteria, providing a modern way to recognize professional development, accomplishments, or learning milestones.
new_award
POSThttps://api.bws.ninja/v1/call
Use this operation to award a badge to an individual (recipient).
Use this operation to get the list of awards for ALL the issuers you have registered.
list_awards
POSThttps://api.bws.ninja/v1/call
Get the full list of awards.
Request Body
{"statusCode":200,"info": [ {"@context":"https://w3id.org/openbadges/v2","type":"Assertion","id":"https://badges.staging.bws.ninja/certify-badge/award/db06f3e5-43c8-447f-bc82-232df1f3be62","recipient": {"type":"email","hashed":true,"salt":"0f02bc8522","identity":"sha256$c7009cc9daf7971c763734a217eadd14572f16cbb397cd61242621459822cbb2","name":"Nacho Coll" },"badge": {"type":"BadgeClass","id":"https://badges.staging.bws.ninja/certify-badge/badge/0c4078ab-8195-40fa-9d8d-0389b5547a86","name":"Blockchain Web Services Developer Associate", "description": "Recognizes professionals who have demonstrated expertise in blockchain, including development and management of blockchain applications and services using Blockchain Web Services API.",
"image":"https://ipfs.bws.ninja/ipfs/QmXAkiFMsrMYQEiZE76oZ2hT4YEu97bvh8wdCnApvpFdeG","criteria": { "narrative": "To earn this badge, complete an accredited course in blockchain, demonstrate practical experience with a portfolio of Blockchain Web Services solutions, and pass an exam on blockchain computing concepts, service models, and development practices."
},"issuer": {"id":"https://badges.staging.bws.ninja/certify-badge/issuer/a68d1d72-1365-4114-8349-0b2e220f43e3","name":"Blockchain Web Services","url":"https://www.bws.ninja","email":"info@bws.ninja","type":"Issuer" } },"verification": {"type":"HostedBadge" },"issuedOn":"2024-01-17T17:55:31.903Z" } ]}
Once executed correctly, you will get a list of your account badge awards.
{"statusCode":200,"info": [ {"@context":"https://w3id.org/openbadges/v2","type":"Assertion","id":"https://badges.staging.bws.ninja/certify-badge/award/db06f3e5-43c8-447f-bc82-232df1f3be62","recipient": {"type":"email","hashed":true,"salt":"0f02bc8522","identity":"sha256$c7009cc9daf7971c763734a217eadd14572f16cbb397cd61242621459822cbb2","name":"Nacho Coll" },"badge": {"type":"BadgeClass","id":"https://badges.staging.bws.ninja/certify-badge/badge/0c4078ab-8195-40fa-9d8d-0389b5547a86","name":"Blockchain Web Services Developer Associate", "description": "Recognizes professionals who have demonstrated expertise in blockchain, including development and management of blockchain applications and services using Blockchain Web Services API.",
"image":"https://ipfs.bws.ninja/ipfs/QmXAkiFMsrMYQEiZE76oZ2hT4YEu97bvh8wdCnApvpFdeG","criteria": { "narrative": "To earn this badge, complete an accredited course in blockchain, demonstrate practical experience with a portfolio of Blockchain Web Services solutions, and pass an exam on blockchain computing concepts, service models, and development practices."
},"issuer": {"id":"https://badges.staging.bws.ninja/certify-badge/issuer/a68d1d72-1365-4114-8349-0b2e220f43e3","name":"Blockchain Web Services","url":"https://www.bws.ninja","email":"info@bws.ninja","type":"Issuer" } },"verification": {"type":"HostedBadge" },"issuedOn":"2024-01-17T17:55:31.903Z" } ]}
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.