This article explains how to use our API documentation.
The RecMan API documentation is split into sections, which you'll find in the category For developers.
For each section, you'll find all the details on how to retrieve and modify data in your RecMan account.
In most cases, the sections will have different articles to help you along the way. Here are some explanations of what you can expect to find in these articles:
Retrieve Data
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 are required or available.
- A quick testing tool to let you try and explore the API
- A 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 provide quick details and a 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.
Reference
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 detail, you'll usually find a list of all available fields.
The fields list will let you know which fields are required, what format you need to use, and, in some cases, where to find the required data.
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.