Best Practices

Caching

When building with Osmek, it's important to implement a good caching mechanism. Caching will increase the speed and reliability of your site. Osmek.php has excellent caching methods built in for Osmek feeds, and even images. We recommend caching feeds for 10 minutes.

Clearing the Cache

By utilizing Osmek's postback feature, you can selectively clear cache files when content is added or updated.

A PHP example can be found in the Osmek.php documentation.

API Version Binding

As Osmek releases updates, versions of the API are branched off and kept running. You can view the current API version by visiting http://api.osmek.com/ in your browser. Access an older version by appending the version number to the api endpoint. Example: http://api.osmek.com/3.0.8 or http://api.osmek.com/3.0.8/feed

It is highly recommended to bind all of your API calls to a specific version. This will protect your application against changes to the API.