Before you start
What to have ready before your first credential. Governance takes the most planning.
Getting ready takes three kinds of work. Administration sets up your account. Governance decides what your credentials mean and who grants them. Development builds those decisions into your systems.
Governance takes the most planning. A credential can never change once it is on chain, so its wording has to be final and approved before you create it. Start there.
Administration
The question: how will you get access to Andamio Issuer?
Order a plan
Order a plan at issuer.andamio.io. Know your cohort size first, because a plan sets three limits:
| Limit | One is used by |
|---|---|
| Users | Each account you create for a person |
| Credentials | Each learner whose evidence a teacher accepts |
| Courses | Each course you create |
Register your site's address
Social login lets people sign without installing a wallet, but it only works on a site address Andamio has approved. Register yours (for example app.yourcompany.com) at issuer.andamio.io.
Do this early. An Andamio operator approves each address by hand, and your API key is issued after that.
Governance
The question: what will your credentials mean, and who will grant them?
Define each credential
A credential certifies what someone can do. You define it as an ordered list of statements, such as "I can run a safety inspection". A person earns it when a teacher accepts their evidence for it.
The ordered list of statements defines the credential within its course. Changing a word or the order makes a different credential, and nothing can be edited on mainnet. Write each list, get it approved and put it in order before you create the credential. How it works has the rules for a statement.
Group your credentials into courses
Every credential belongs to a course, and a course can hold many credentials. Everything in a course shares one owner and one set of teachers, and one credential can require another only inside the same course.
So group credentials that the same people approve, or that build on each other. A course can match a class, a training track or a certification, but it does not have to.
Decide what learners submit as evidence
Decide what counts as evidence for each credential. Then decide where you store it, how long you keep it and how you delete it when someone asks. The evidence itself never goes on chain.
Name a course owner and teachers
Pick a course owner from your own staff, and the teachers who will accept evidence. Each needs an alias, and aliases are public and permanent, so choose them with care.
Write a privacy notice
Write a privacy notice that names who controls the data. People see it before they connect a wallet.
Development
The question: how will your systems carry out those decisions?
Build the three screens
Andamio Issuer is an API with no app for learners or reviewers, so you build the screens your people use. A learner submits evidence on one, a teacher accepts it on another, and a learner claims the credential on the third. API integration has the API calls behind each one.
Connect wallets
Each person signs through social login or a browser wallet. Social login only works on the address you registered in Administration. Show the privacy notice before anyone connects.
Store evidence and submit its fingerprint
Keep the evidence where governance decided. With each submission, send a short text of up to 140 characters that goes on chain: a hash of the evidence, or a public URL if the evidence is already public. That text is public and permanent, so never put personal data in it.
Watch your credit balance
If a batch of acceptances needs more credentials than your plan has left, the whole batch is refused with 402 QUOTA_EXHAUSTED. Check what is left with GET /quota, and Roles and actions has the details.
Next
- Roles and actions covers the access token, the roles and the credential loop.
- API integration takes your developer from a key to issued credentials.