StartCommand API

Home > StartCommand API

StartCommandでは、登録されているコマンドを検索したり、実行した結果のURLを取得することができるAPIを一般公開しています。
StartCommandのWebサービスを利用することで、皆さんのサイトやアプリケーションと、StartCommandを連携するアプリケーションの開発、サービスの構築にご活用ください。

現在、個人・法人に関らず、また商用・非商用を問わず使用できます。
WEB APIに対する要望や質問は、お問い合わせください。

StartCommand APIを利用することによって、ガイドラインの内容に同意いただいたものとみなします。本ガイドラインに同意いただけない場合は、StartCommandのAPIを使用するライセンスは許諾されません。

インターフェース

StartCommand APIは、GETリクエストを投げて、XML形式の結果を受け取ります。
リクエストのパラメータは、UTF-8でURLエンコードしてください。

ご利用の際の注意点

StartCommand APIはベータバージョンです。利用状況により、サービスの仕様変更、あるいはサービスを停止する可能性があります。
StartCommand APIを利用するアプリケーションは、見やすい位置に下記のクレジット表示をしてください。
StartCommand APIの利用はリクエスト元のIP毎に制限が設けられています。現状では 1IP あたり 24時間に 5,000回が上限となっています。

クレジット

コマンド検索

スタンドに登録されているコマンドを検索します。

http://www.startcommand.com/api/command/?

このあとには、実際のクエリーパラメータが続きます。パラメータは「引数=値」の形式をとります。引数と値はURLエンコードします。複数パラメータは'&'で区切ります。

パラメータ	項目	説明	必須	値
stand	スタンド名	検索するコマンドのスタンド名を指定します。	*1	(例)sample
keyword	キーワード	検索するキーワードを指定します。コマンド名を前方一致で検索します。	*2	(例)goo

*1　スタンド名を指定しない場合は、ルートのコマンドを検索します。
*2　キーワードを指定しない場合は、全件のコマンドリストを返します。

レスポンス

フィールド	説明	例
results
count	コマンド数	10
stand	スタンド名	sample
commands	コマンド情報
command	[複数要素]
name	コマンド名	google
title	タイトル	googleウェブ検索
help	説明	世界でもっとも利用されている...
icon	アイコンURL	http://www.google.com/favicon.ico
category	カテゴリ	Web検索
type	タイプ（1:Webサイト、2:Web API、3:RSSフィード）	1
options	オプション情報
option	[複数要素]
name	オプション名	num
title	タイトル	表示件数

サンプル

http://www.startcommand.com/api/command/?stand=sample&keyword=goo

<?xml version="1.0" encoding="utf-8" ?>
<results>
  <count>2</count>
  <stand>sample</stand>
  <commands>
    <command>
      <name>goo_rosen</name>
      <title>goo路線検索</title>
      <help>経由駅の指定ができ、自由席、指定席、グリーン車の料金が確認できます。
出発駅と到着駅をパラメータで指定してください。（-keiyuで経由駅も可）</help>
      <icon>http://map.goo.ne.jp/gooicon.ico</icon>
      <category>路線・経路・時刻表</category>
      <type>1</type>
      <options>
        <option>
          <name>keiyu</name>
          <title>経由駅</title>
        </option>
      </options>
    </command>
    <command>
      <name>google</name>
      <title>Googleウェブ検索</title>
      <help>世界でもっとも利用されている検索エンジンです。
-numで表示件数(50)、-langで対象言語(lang_ja)、-domainでドメイン指定検索ができます。</help>
      <icon>http://www.google.com/favicon.ico</icon>
      <category>Web検索</category>
      <type>1</type>
      <options>
        <option>
          <name>domain</name>
          <title>検索対象のドメイン</title>
        </option>
        <option>
          <name>lang</name>
          <title>lang_ja=日本語ページ、lang_en=英語ページ</title>
        </option>
        <option>
          <name>num</name>
          <title>1ページの表示件数(10, 20, 30, 50, 100)</title>
        </option>
      </options>
    </command>
  </commands>
</results>

コマンド実行結果

コマンドラインのテキストを実行した結果を返します。

http://www.startcommand.com/api/execute/?

パラメータ	項目	説明	必須	値
stand	スタンド名	実行するコマンド対象のスタンド名を指定します。	*1	(例)sample
line	コマンドライン	実行するコマンドラインのテキストを指定します。	○	(例)google -num 100 人気

*1　スタンド名を指定しない場合は、ルートのコマンドを使用します。

レスポンス

フィールド	説明	例
results
stand	スタンド名	sample
urls
url	[複数要素] コマンド実行結果のURL	http://www.google.com/search?hl=ja...

コマンドは「google+yahoo 人気」のように、複数のコマンドを同時に呼び出すことができます。
この場合、実行結果のURLが2つ返されます。

サンプル

http://www.startcommand.com/api/call/?stand=sample&line=google%2Byahoo+-num+100+%E4%BA%BA%E6%B0%97

<?xml version="1.0" encoding="utf-8" ?>
<results>
  <stand>sample</stand>
  <urls>
    <url>http://www.google.com/search?hl=ja&lr=lang_ja&num=100&q=%E4%BA%BA%E6%B0%97</url>
    <url>http://search.yahoo.co.jp/bin/search?n=100&fl=1&vl=lang_ja&vf=&p=%BF%CD%B5%A4</url>
  </urls>
</results>

エラー時のレスポンス

APIのエラーは下記のレスポンスで返します。

レスポンス

フィールド	説明	例
results
error	エラーメッセージ	コマンドラインが不正です。

サンプル

<?xml version="1.0" encoding="utf-8" ?>
<results>
  <error>コマンドラインが不正です。</error>
</results>