hiogi developers program – API documentation

Overview API Calls:

  1. Get answered questions
  2. Get open questions
  3. Post a new question
  4. Get news
  5. Get user status
  6. Get app_token (user authentification)
  7. Get URL token (user redirect with automatic login)
  8. Log out of a user (disable app_token)

Note:
SSL encryption and your individual app_id is needed for all calls. Get your app_id by joining our developers program here. It is free.

Unless otherwise noted, methods exposed by the hiogi API require a GET request.

Encoding
The hiogi API supports UTF-8 encoding. Please note that angle brackets ("<" and ">") are entity-encoded to prevent Cross-Site Scripting attacks for web-embedded consumers of JSON API output.

Get answered questions

This call gives you the latest questions that have been answered including comments, dates and usernames. You do not need an authentification with an app_token for this call.

URL: https://api.hiogi.net/1.0/questions.format
Formats: xml, json
Parameters:

  • # app_id | Your application ID
    Required | GET
  • # callback | callback function wrapper for cross domain JSON requests (JSONP)
    Optional | GET
  • # lang | Gets questions with a certain language de (German) or en (English)
    Optional | GET
  • # search | Gets the last 20 questions for a search term (multiple terms as AND)
    Optional | GET
  • # keyword | Gets the last answered questions for a certain keyword promotion
    Optional & restricted | GET
  • # amount | Gets a certain number of questions (1 to 20)
    Optional | GET

Example XML result

2. Get open questions

This call gets the latest open questions. No authentification with an app_token is needed.

URL: https://api.hiogi.net/1.0/questions/open.format
Formats: xml, json
Parameters:

  • # app_id | Your application ID
    Required | GET
  • # callback | callback function wrapper for cross domain JSON requests (JSONP)
    Optional | GET
  • # lang | Gets open questions with a certain language de (German) or en (English)
    Optional | GET
  • # keyword | Restricted partner call: Gets the last open questions for a certain keyword promotion
    Optional | GET
  • # page | Gets the next 20 open questions
    Optional | GET
  • # amount | Gets a certain number of open questions (1 to 20)
    Optional | GET

Example XML result

3. Post new question

This call posts a new question. Authentification of the user with an app_token is required. This call is restricted and may only be used by mobile applications.

URL: https://api.hiogi.net/1.0/questions/new.format
Formats: xml, json
Parameters:

  • # app_id | Your application ID
    Required | GET
  • # app_token | The token of the user for your application
    Required | GET
  • # callback | callback function wrapper for cross domain JSON requests (JSONP)
    Optional | GET
  • # content | Text of the question (max. 255 digits)
    Required | GET

Example XML result

4. Get news

This call gets the latest news. No authentication with an app_token needed.

URL: https://api.hiogi.net/1.0/news.format
Formats: xml, json
Parameters:

  • # app_id | Your application ID
    Required | GET
  • # callback | callback function wrapper for cross domain JSON requests (JSONP)
    Optional | GET
  • # lang | Gets news with a certain language de (German) or en (English)
    Optional | GET

Example XML result

5. Get user status

This call gets all relevant and personal information of the authenticated user (daily rank, monthly rank, total rank, x new messages, x new comments, etc.) An authentification of the user with an app_token is required.

URL: https://api.hiogi.net/1.0/status.format
Formats: xml, json
Parameters:

  • # app_id | Your application ID
    Required | GET
  • # app_token | The token of the user for your application
    Required | GET
  • # callback | Callback function wrapper for cross domain JSON requests (JSONP)
    Optional | GET

Example XML result

6. Get app_token for user (user authentification)

a) Web applications:

If you are programming a web application you can authenticate a user and get his/her personal data afterwards by first sending him/her to the authentification page on our site (http://www.hiogi.de/applications/appLogin/?app_id=123xxx789xxx345xxx20). The user will log in on our site (authentification) and gets redirected to the Callback-URL that you specified in your developer account with the individual app_token for the user attached. You can store the app_token for the user in order to authenticate him/her in the future. The user can disable the app_token by logging out in your application (see call no 8.) or disabling the app_token in my hiogi on the site.

b) Desktop applications:

If you are programming a desktop application and you want to authenticate a user in order to get his personal data, you first need to get an app_token for the user by using the call described below before you can redirect the user to the authentification page already with an app_token attached (http://www.hiogi.de/applications/appLogin/?app_id=123xxx789xxx345xxx20&app_token= tt3xxxt89xxxt45xxx20). Once the user logged in with his/her username and password on the authentification page the app_token becomes activated and you can pull the personal data for that user. The user can disable the app_token by logging out in your application (see call no 8.) or disabling the app_token in my hiogi on the site.

Note: The app_token will expire after 7 days of user inactivity.

URL: https://api.hiogi.net/1.0/auth/get_app_token.format
Formats: xml, json
Parameters:

  • # app_id | Your application ID
    Required | GET
  • # callback | Callback function wrapper for cross domain JSON requests (JSONP)
    Optional | GET

Example XML result

7. Get URL token (Automatic redirect with login)

This call gets a unique URL token in order to redirect the user to a certain personal area on our site (redirectURL, e.g. his inbox) directly from within your application without having the user to log in on the hiogi site. The URL token can only be used once and expires immediately after being used.

Note: The URL token is a one-time token and expires immediately after being used

URL: https://api.hiogi.net/1.0/helper/get_url_token.format
Formats: xml, json
Parameters:

  • # app_id | Your application ID
    Required | GET
  • # app_token | The token of the user for your application
    Required | GET
  • # redirect_url | URL to redirect the user to after log in
    Required | GET
  • # callback | Callback function wrapper for cross domain JSON requests (JSONP)
    Optional | GET

Example XML result

8. Logout of a user (disable app_token)

This call disables the app_token of a user. An authentification with an app_token is required.

URL: http://api.hiogi.net/1.0/auth/logout.format
Formats: xml, json
Parameters:

  • # app_id | Your application ID
    Required | GET
  • # app_token | The token of the user for your application
    Required | GET
  • # callback | Callback function wrapper for cross domain JSON requests (JSONP)
    Optional | GET

Example XML result

Login
Auf diesem Computer merken

Die Google Map von
hiogi zeigt Dir gute Fragen, Antworten und hiogis aus Deiner Region. Mehr...

Top Mitglieder des Tages

Top hiogis des Tages

Sei einer der Top5-Antwortgeber des Tages und gewinne Ogi-Taler. Die Gewinner von gestern findest Du unter Gewinne.

loading...