API

Osmek's API allows you to access and interact with all the information in your account from any external server, and in a number of different formats

The API can be accessed at the following URL:

http://api.osmek.com/

You will append the method you wish to call to this url. For example:

http://api.osmek.com/feed

Scripts

You can find scripts for using the API on your server in the Integration Scripts section. Osmek.php is developed and maintained by the Osmek team and is highly recommended if your server can run PHP.

Methods

Methods are divided into two categories: read only, and read/write. They allow you to access content and interact with content in your account. You can do things like add, and update content.

Feeds


Methods

You will interact with these methods via POST information. Every feed requires at minimum your account API key (api_key), and the section id (section_id) you wish to interact with. Each method may require additional parameters.

Response Formats

Each feed & method will return data in one of the following formats, based upon what you specify via the format parameter in your request. Example: &format=json.

  • json
  • php
  • html
  • xml
  • custom (requires a template parameter)