APIの基礎について学ぶ

APIの基礎について学ぶ

オリジナル: http://wiki.lingr.com/dev/show/API+Basics

翻訳日: 2006/01/27

原文リビジョン: 9


概説

Lingr APIシンプルHTTPメソッドの集合体であり、Lingr Webサイトの外からのLingrサービス利用を可能にするものです。

それぞれのメソッドは呼び出しが成功したか失敗したかを表す応答を返すと同時に、メソッドによって異なる追加の値を返します。応答はデフォルトではXMLで為されますが、JSONを求めることも出来ます。

引数、応答、エラーコードはそれぞれのメソッドのSpecページに記載されており、メソッドの一覧はAPIリファレンスページにあります。

HTTPメソッド(GETかPOSTか)

Lingr APIメソッドの呼び出しはシンプルHTTPリクエストで為されます。一部のメソッドはGETで呼び出す必要があり、その他はPOSTで呼び出す必要があります。

POSTで呼び出す必要のあるメソッドの場合、パラメータリクエストの本体に含める必要があり、Content-Typeはapplication/x-www-form-urlencodedとしてください。

文字コード

Lingrは完全に国際化されたアプリケーションであるため、Lingr APIのすべての入力内容はUTF-8符号化されている必要があります。また、応答も全てUTF-8符号化されています。

APIキー

Lingr APIを使用するにはAPIキーが必要です。私たちはAPIキーをAPI使用状況の追跡に使用しており、Lingr API利用規約が遵守されているか確認しています。

APIキーを取得するのは簡単です。Lingrアカウントを取得し、APIページを開いてください。Lingr API利用規約を読んで承諾の上でリンククリックすればOKです。