FAQ

How do I start the WebKatalog with a different catalog path?

Pass the parentnode parameter in the call. It sets the start folder. If parentnode is empty, the top-level folder is used.

parentnode is the nodeid returned by a catalog call.

Example:

https://web.3doffice.de/webkatalog2_5/planning?parentnode=tische

How do I get a token?

See Authentication — it has step-by-step instructions and a PHP sample implementation.

Can I open the WebKatalog without a token?

No. Without a token parameter, the WebKatalog uses the last token it was given (in an iFrame from sessionStorage, otherwise from a cookie). If there is none, it opens the login page – in an iFrame, in a new tab. Automated calls always need a valid token.

How long is a token valid?

• Default (RememberMe=false): 12 hours after last use
• With RememberMe=true: 90 days

What is the difference between reinitstring and ocdreinitstring?

• reinitstring — For use in odb.dll (graphics data)
• ocdreinitstring — For use in ofml.dll (commercial data)
• ocdreinit — URL parameter for use in the frontend

All of them contain the same commercial configuration data but are used in different places.

How do I save a configured article?

There are two options:

1. PermanentID (complete meta configuration): Use the "Generate ID" button in the frontend (parameter buttongeneratereinitid=true). See PermanentIDs.
2. Reconfiguration via ID: POST the top-level article JSON to /api/ofml.dll/ofml/reinit and pass the returned id with ?id=. See Shopping cart integration.

How do I embed the WebKatalog in my web shop?

1. Generate a token
2. Embed the WebKatalog via iFrame: {BASE}/planning?token={TOKEN}
3. Pass the shopping cart URL: &urlwarenkorb=...
4. Process the POST data in your shopping cart

See Shopping cart integration.

How do I change a property through the API?

POST to /api/ofml.dll/ofml/articles. The body contains the property to change (propclass, prop, newvalue) and the complete article JSON as a string in jsondata; each call changes one property. See Change articles.

How do I render an article image?

GET /api/odb.dll/odb/articlesimage.jpg with the required parameters. See Article images.

Can PermanentIDs be transferred between the test and production systems?

No. PermanentIDs cannot be transferred between the systems. See PermanentIDs.