About API keys

The Maventa API-keys are 16-byte strings, called UUID’s (Universally Unique Identifier). An API-key in Maventa looks like this c35db559-dd4c-423d-9ca7-f334f94aa074 (this is a dummy, please refrain from using this in your experiments). There are currently two types of API-keys: Personal API-keys and Partner API-keys, and they both obey the UUID format.

How do I obtain my API-key?

Your Personal API-key is automatically generated upon account creation. The API-key is presented to you as soon as your account has been successfully activated. You can also see your Personal API-key by logging into the Maventa-GUI and browsing to Settings -> Details

Public Application / Vendor API-keys can only be accessed by users who have opened a Maventa Partner Account. These API-keys are usually bound to a certain version of the partner’s software and can be managed in the Maventa-GUI under Settings -> Software API keys

Personal API-key, Partner API-key – you get me confused?

The Personal API-key is the key which is similar to your username and password combination in connections through the machine-to-machine API. The Personal API-key identifies your company and allows the access to your company’s sensitive data. Therefore it is of utmost importance that this key is kept secret! Your Personal API-key is equivalent to the PIN-number of your credit-card – do not lose it, nor tell it to anyone you wouldn’t trust your credit-card PIN with.

The Partner’s API-keys are used to track software that they distribute. These API-keys are not sensitive for prying eyes and are usually bundled, transparent to the end-user, in to the distributed software source code.

Is my Personal API-key(s) subject to change?

No. Your Personal API-key is not bound to your username or password used to log in to Maventa-GUI. It will not change unless you regenerate it yourself in the Maventa-GUI under “Settings”. Note: If you change your API-key, you must assure that you change it also in the software from where you wish to use the Maventa Service and all other services authenticating as your company against the API.

I suspect that my API-key(s) are being used by someone else – not representing our company?

Request a change of your Personal API-key. You can do that in the Maventa-GUI under “Settings”.