Modulus Catalog API

Limits:

Your calls are limited based on your plan.
Please consult your plans throttling, to see how many parallel calls per second are allowed for your module.
If you abuse the limitations, first your calls will be delayed to match the limit, but if you continue, your IP will be blacklisted for 10 minutes!
If you integrate with our API and you need the data to be shown for your customers, please use a caching mechanism on your servers, instead of forwarding those request to us.

Available Functions:


• info

Returns information about a module, share, user, module rights or module setup

• mngField

Manages custom fields.

• load

Load function for the JS lib. It returns all the module related setup data.

• show

Show function for the JS lib. It returns all the module related items.

• loadShow

LoadShow function for the JS lib. It returns all the module related setup data and items.

• mngItem

Manages Items.

• mngModuleItem

A composite function over mngItem, that can add new items, and accepts field values in normal or human encoded format!

• search

Searches for catalog items.

• export

Returns data formatted for export.

• mngSection

Manage catalog sections

• mngMenu

Manage vertical organization of the catalog items

• download

Creates an archive with item files


Possible errors and codes returned

Code 1: Acces denied for private function call!

Code 2: Internal Database Error, can not connect to Database!

Code 3: Function is not available!

Code 4: Invalid JSON parameter!

Code 5: Internal Error caused by invalid JSON!

Code 6: Too many requests, you can send 1 request in every LIMIT s!

Code 7: Your IP was banned for 10 minutes, because of abusive requests, you can send 1 request/limit period!

Code 8: Invalid API key!

Code 9: Unknown action!

Code 10: Call is not allowed from your IP: %IP%

Code 100: Composed keys from different modules or apps!

Code 102: You do not have the right for this operation!

Code 115: Module does not exists!

Code 116: Share does not exist!

Code 152: Option values are mandatory for select or multiple select!

Code 157: Duplicate option name `%FIELD%`!