🔌Connect Your Application
Learn how to connect LearnCard to your existing applications, enabling seamless sharing and earning of credentials.
How Connected Applications Work
(optional) Apps in the Trusted App Registry will be displayed in the LearnCard Launchpad.
(optional) Users will be redirected to your connectUrl when they click connect.
(optional) Users sign up / login to your application.
Through a direct link, or a QR code, your application redirects the user to
https://learncard.app/launchpad?connectTo=yourAppProfileId&challenge=aaaa-bbbb-cccc-dddd
The user will be given the option to Accept or Deny the request to connect with your application.
If you are not in the Trusted App Registry, the user will see the "Unknown App Request" prompt:
If they Accept the connection request, they will be connected with your application and select the credentials that they wish to share with your application.
After clicking "Share Credentials" they will be redirected to your redirectUrl
You now have an active connection with this user and their LearnCard! This enables you to bi-directionally share and send credentials and presentations to each other using the LearnCard Network API . 🎉
Getting Started
You've decided that you would like to enable your users to connect their LearnCard to your application—that's great! Let's get started.
First, install the Network Plugin for LearnCard in your project:
Add a Network LearnCard to your Application & Create a Service Profile
There be dragons here. 🐉
In production environments, take great care and caution when generating and storing key material. Insufficient entropy or insecure storage, among other vectors, can easily compromise your data and identities.
Refer to Key Generation for more information.
ConnectUrl
A URL where users will be redirected to when they click the "Connect" button in the LearnCard app
This URL should link to a co-branded page for your application and LearnCard. You may wish to have users signup for your application here.
When you're ready, generate an invitation to connect with your application and redirect them back to LearnCard
RedirectUrl
A URL where users will be redirected to after they select credentials and click the "Share Credentials" button.
You can then get the verifiable credentials that the user just shared with your application!
⭐️ Become a Trusted Application
Trusted Applications are in beta! Soon
Submit a PR in the LearnCard Registry with the following information added:
Organization info
Name
Address
App info
Name
Short description (~25 characters)
App Icon URL
Whether you wish to allow users to edit/update the credentials that they share with you
URLs
Main URL for your application (e.g.
learncard.app
)
LearnCard Network Profile ID
This is the string that you specify when creating your Network LearnCard
DID Associated with your Application
This is the DID associated with your Network LearnCard
Last updated