Can anyone use the API?
At present, anyone can write code to talk to the API and consume a miiCard member's identity data so long as they consent to share information with your application. However, at the moment you can only consume the data of members who:
- Have assured their identity by linking a financial account or equivalent to their miiCard account - the same pre-condition for publishing a public profile page
- Have a valid subscription (or are a lifetime member)
- Agree to share data with your application
To obtain a consumer key and secret, we do require that you have a validated miiCard account.
How do I get a consumer key and consumer secret?
Take a look at the Getting Started section for a form to fill in - the more information you can supply about what you want to do, the quicker we'll be able to help out.
Why do you ask for so much information to obtain a consumer key?
The privacy and security of our members is important, and we want to make sure that their identity data is going being used in an appropriate way.
We also want to get involved in integrations to make them as smooth and simple as possible. By finding out a bit more about how you're planning to use miiCard we're better placed to offer you guidance and support before development starts, and assistance during and after implementation. If you're trying to do something with miiCard that we don't support yet then we can talk about that too.
What sort of identity information can I request of a miiCard member?
At the moment you can request any information that a member can also elect to make public on their profile page. This includes:
- Their name
- Email addresses
- Phone numbers
- Social media and other online identities
- Web pages and domains
- and more...
Take a look at the API documentation, in particular the MiiUserProfile object type - just let us know which fields you'd like populated and which you want to be mandatory. We ask that you only request information that you actually need for your use case - the less information you require from a miiCard member, the more likely it is that they'll share it with your application.
A number of ways:
- Use the miiCard Developers forum, where you can ask questions from the developer community or just spitball ideas and suggestions for the API or our libraries and components
- Send us a support request
- Use the GitHub issue tracking pages for the API wrapper library or component you're using, if you're having trouble with it