Advanced API parameters

In addition to the list of regular parameters for the Light Blue API, there are a number of parameters that can be used by anyone sending data from another system to the Light Blue API, or building their own plugins.

HEALTH WARNING: you should not use these parameters if you’re using one of our WordPress plugins, because the plugins already supply them for you.

KeyTypeNotes
SourceTexte.g. “Tom’s custom Light Blue plugin”. This helps us to track down problems any might have with a specific plugin or service that’s sending data to the Light Blue API, as well as ensuring that IDs or References provided by different services don’t clash.
SourceAPIVersionTextThe version number of your plugin. This helps us to track down problems any might have with a specific plugin that’s sending data to the Light Blue API
IDTextIf an ID parameter is supplied, the Light Blue API will check that it hasn’t already received a duplicate API request. The Light Blue API checks for a unique combination of your ID parameter and the Source parameter (so different sources of data can use the same ID without clashing).
Was this article helpful?
0 out of 5 stars
5 Stars 0%
4 Stars 0%
3 Stars 0%
2 Stars 0%
1 Stars 0%
How can we improve this article?
Table of Contents