Welcome to RecMan API documentation.
If you notice any problems using this API, please contact firstname.lastname@example.org
How to use our documentation
The RecMan documentation is split into different categories, which you’ll find on the left side of this page.
For each category, you’ll find all the details on how to retrieve and modify data in your RecMan account.
In most cases, the categories will have different pages to help you along the way. Here are some explanations on what you can expect to find on these pages:
On the GET page, you’ll find details on how to retrieve and view data from your RecMan account. Here you’ll usually find:
- Details about the scope and which parameters that are required or available.
- A quick testing tool to let you try and explore the API
- Some few code-examples to help you along the way.
A list of all available and required fields for this scope will be located on the reference pages.
Insert, Update and Delete
These pages will mainly give you some quick details and few code-examples on how to insert, update and delete data in your RecMan account. These examples are built to help you understand how to use the details you’ll find on the reference pages.
Our examples are always shown in PHP or JSON. You’re free to use the scripting language you prefer.
The reference guide pages will show you all details on how to insert, update and delete data in your RecMan account. This page will mostly start with some details about the scope, available operations and the URL to use. Underneath each scope details you’ll usually find a list of all available fields.
The fields-list will let you know which fields that are required, what kind of format you will need to use and in some cases details on where to find the data that is required.
If the scope has fields that are objects (fields with subfields) you’ll find details about the field and each subfield that is available beneath the field list.
Obtaining an API-key
New API-keys can be generated in the System Settings-page in your RecMan account
System Settings -> Database -> API -> Create
You will have to be a system administrator to be able to view or create an API-key.
Once created, you will have to add access to your API-key, deciding which modules it should have access to, and which operations that are allowed.
Always limit your access to only contain the modules and operations you need. Especially if you share your API-key with external developers.
Please note that the API has a maximum of 200 loads per day (reset at midnight) for free. Any lookup after this will cost 0,09 kr per lookup. We therefore recommend to cache your feed in your own system, in order to avoid the lookup limit of 200.
One solution to restrict the number of requests (loads per day) is to download the json-file, and time stamp it. A script can check the time stamp periodically, and once the time exceeds a set limit, the system fetches a new file.
Our API does not support “Access-Control-Allow-Origin”. As this would basically mean that any client-side operation would expose your API-key, we have decided not to enable this feature.