すばらしい言葉:API

素晴らしい言葉 昨年2月、私たちはGreat Wordsプロジェクトを発表しました。 このトピックでは、サードパーティの開発者がプロ​​ジェクトに基づいて製品を作成できるように作成されたAPIを紹介します。 デザインで引用符を使用するのは簡単で簡単です。



APIはXMLで 「通信」します 。 要求形式と応答形式は次のとおりです。 必要なのは、生成されたリクエストをhttp://api.greatwords.ru/に送信し、回答を解析することだけです。



まず、APIの使用を開始するために、見積書を使用するソフトウェア製品(アプリケーション、ウィジェット、Webサイト)を示す必要がある手紙( http://api.greatwords.ru/ページのアドレスを参照)を書く必要があります。 その後、一意のキー(APIキー)を受け取ります。これをリクエストで渡す必要があります。



要求はGETおよびPOSTメソッドによって受け入れられます。 リクエストでは次のパラメータを使用できます。

  1. apikey = <APIキー> -一意のキー(必須パラメーター);
  2. by =(著者|キーワード|ユーザー|お気に入り|ランダム|新規) -パラメータ(著者別、ラベル別、引用を追加したユーザー別、選択したユーザー、ランダム、日付別)引用または引用を取得しますか(必須パラメーター) );
  3. 条件= <条件> -条件; 条件は、作成者、タグ、またはユーザーの識別子、および作成者の名前、タグワード、ユーザー名、または検索クエリ(オプションのパラメーター)です。
  4. count = <amount> -必要な引用の数(オプションのパラメーター);
  5. random = 1-条件を満たすランダムに選択された引用符が必要であることを示すパラメーター(オプションのパラメーター)。


たとえば、ラベル「 love 」のすべての引用符を取得するには、クエリは次のようになります。by = keyword&condition = 7 (7はこのラベルのIDです)。 さらに、このタイプのクエリ: by = keyword&condition = loveを使用できますが、この場合、テキストはUTF-8エンコードである必要があることに注意してください。



別の例:10個のランダムな引用符を取得する必要があります。 この場合、リクエストは次のようになります: by = random&count = 10 。 そして、10個の新しい引用符を取得するには、 by = new&count = 10のクエリを使用する必要があります。



最後に、お気に入りから毎回ランダムな引用を取得したい場合の例を示します。 次に、次のクエリを使用する必要があります: by = favourites&condition = <id>&count = 1&random = 1 (ここで<id>はユーザーID)またはby by Favorites&condition = <login>&count = 1&random = 1 (<login>はログイン) )



答えは次の形式で形成されます。

<グレートワード>

<引用>

<link> http://greatwords.ru/quote/20/ </ link>

<content>馬鹿に生まれるのは恥ずかしいことではなく、愚か者を死ぬことだけが恥ずべきことです。</ content>

<著者>

<name> Erich Maria Remarque </ name>

<link> http://greatwords.ru/author/2/ </ link>

</ author>

<source> 3人の仲間</ source>

<年> 1938 </年>

</ quote>

<引用>

...

</ quote>

</ greatwords>



APIを使用する場合、 greatwords.ruおよび/または著者/引用のページへのハイパーリンクが必須です。



All Articles