API:v1r1:get key

From MixxHelp

Jump to: navigation, search

API Main

Obtaining and Configuring an API Key

All calls to the Mixx API, even just the echo service, require a valid API key. If you have a Mixx account, you can create a key here: Your API Keys

When creating a key, you're asked for several pieces of information, all of which can be edited later (but some of which must be populated in order to process the form). Of particular note, a checkbox at the bottom of the form allows you to "Display this application in the public Mixx API directory." It is disabled by default, but if you don't check this box it doesn't mean your API key won't work, it just means that we won't surface your application in the list of apps we display to users. This is so you can create a key and start working on your application without worrying that we're going to advertise it before you're ready. Once you are ready to begin serving users, you can come back and check that box and we'll know it's okay to tell everyone.

Once you've created your key you'll be taken back to the that lists your keys (you can have more than one if you want to write multiple applications). That page will show you the text of your unique key, as well as your shared secret. Your key is what you will pass as the api_key parameter in your requests.

Your Shared Secret (IMPORTANT)

Your shared secret is tied to your API key. You should think of it like a password, and be sure to never share it with anyone. You never have to pass this secret in API calls, and it should never be shown to users or anyone else. It's used to sign your request when you wish to authenticate a user, or make an authenticated request on behalf of a user. Instructions for signing requests are included in the Authentication section.

Personal tools