API keys are a crucial component for interacting with the VIPE API, whether you're using it for integration into your application or for any other custom use-cases. VIPE ensures that all endpoints require API key authentication for enhanced security. Here in the dashboard and documentation, you'll find the tools to help you get started quickly with authenticated API requests.
Use Your Older API Keys
Older API keys that were provided on the CryptoAvatars site and are associated with user profiles that don't have an email set are still available. However, they cannot be displayed above. If this is your situation, you can either copy and paste your current API key or log in and generate a new one.
The first thing you should do is log into the VIPE docs if you haven't already done so (Disclaimer: Sometimes email clients may block the login email. If you don't receive the email, please check your spam folder). Any API keys associated with your account should automatically be populated above.
Once you've selected an API key, you'll see it's been automatically populated in the authentication field in the top-right corner (where it says How to Authenticate). Below that is a little API playground where you can send an authenticated request. Click that big
Try It! button and see what happens!
Would you like to see how it works on your PC?
You can copy the cURL request, which is fully runnable. Try pasting that into a terminal of your choice, and you should see the exact same results as you see on the playground🚀
Currently, we only support one API key per user. If you already have an API key, then you're all set. If this is your first time visiting the VIPE docs and you're looking to integrate with us, please log in, and we will provide you with a personal API key for your project.
Don't Share Your API Key
API keys are personal and non-transferable. Your throughput could be affected if others use it, or if suspicious activity occurs. So, be careful.
Updated 5 months ago