API Keys
From Plings Info
To either:
- supply data to Plings, or
- get data from Plings
you will need an API Key.
Contents |
Key Types
Generic Development API Key
Development API Key: 5A605302-FC5BC526-4473C6AB-B4D9009B-RQMKMLDM
Please Note: the key should work with or without the hyphens.
If you just want to start to play around with the various data services, then use the 'Development Key'.
Please note:
- The Development API Key will restrict the amount of data you can get/supply.
- All data is supplied to, and comes from a test server - you cannot access live data.
- You may get slightly odd results/cross over with other people's data 'cos you're all using the same key
This key can be used to both READ and WRITE to the development environment
Who would use this:
- Anyone wishing to familiarise themselves with the API
Personal Development API Key
If you register with us, we can issue you're own Development API key. This makes it easier to track your data in the development environment.
You will actually get 2 keys, one to WRITE data to the development data set, and one to READ data back.
Who would use this:
- Anyone experimenting, but hoping to add data to Plings in the future.
- Developers that need to test new functions.
Live API Key
You need to register to get a Live API key. This gives you access to real data.
There are 2 cases to consider:
- READ ONLY - you can access real, live data.
- READ AND WRITE - you can supply data to the Plings dataset. You automatically get READ privileges.
Who would use this:
- READ ONLY - anyone wanting to look at live data, developers creating applications, people that want a live data feed, etc
- READ AND WRITE - trusted data providers that have a relation with us.
Register for a Key
Currently you do this by emailing us at api[at]plings.net. Your email should contain:
- some information about the data you plan to supply, AND/OR the data you wish to use
We may ask you for more information before we issue a live key.
Keep your Keys Safe
You should NOT share your keys with anyone else.
One reason for having API keys is to help us to look after the data so that we can continue to provide a service. We also hope to be able to supply data back about the use of requests by your key. If you share your key with others this data would be meaningless. If someone you have shared a key with uses it to attack the servers, then we would disable access via that key. This would also disable access for you.
Output API safety
We use output API keys to:
(a) Track usage of Plings data; (b) Ensure that third parties to do not mis-use the full data feeds (XML)
You should not redistribute the full XML gained with your output API key. If you are redistributing a feed from the Plings output API then please either only redistribute data that would be available from the reduced RSS, iCal or KML feeds (which do not require an API Key), or ensure that the users you are redistributing to have (and use) their own API keys.
If you redistribute full XML data via your own API Key then if the data you redistribute is abused, we may have to cut off your access to the data to prevent this.
Input API Safety
Input API keys should NEVER be shared. Tools which use the input API key should always be protected by a password - and only trusted users given access to update data which will be fed into the Input API
