APIキット
APIキット一式をリンクからダウンロードできます。
apikit-0.0.3.zip: version 0.0.3
APIキットの内容は下記になります。
apikit-0.0.3.zip
/ruby
asteria-client-ruby-0.0.3.tar.gz
/perl
asteria-client-perl-0.0.3.tar.gz
/coordinatorclient
asteria-client-coordinatorclient-0.0.3.zip
/java
asteria-client-java-0.0.3.zip
/wsh
asteria-client-wsh-0.0.3.zip
/php
asteria-client-php-0.0.3.tar.gz
クライアントのインターフェイス
module API
{
// クライアント
interface Client {
// GET メソッドでリクエストを送信
ResponseResult get( url , data ) ;
ResponseResult get( url , data , headers ) ;
// POST メソッドでリクエストを送信
ResponseResult post( url , data ) ;
ResponseResult post( url , data , headers ) ;
// PUT メソッドでリクエストを送信
ResponseResult put( url , data ) ;
ResponseResult put( url , data , headers ) ;
// DELETE メソッドでリクエストを送信
ResponseResult delete( url , data ) ;
ResponseResult delete( url , data , headers ) ;
}
// レスポンスオブジェクト
interface ResponseResult {
// response
int status() ; // OK, Error , SystemError , Unknown のいずれかを示す整数値
int format() ; // XML, Json , Html , Unknown のいずれかを示す整数値
Object response() ; // それぞれのコンテントタイプに合わせたObject
string text() ; // レスポンスボディの文字列
}
}
Client Object
- get , Method
-
GETメソッドでHTTP通信を行います
url はAPIリストにのいずれかのURLを指定します。 EX パイプライン一覧を取得する場合は
/listdata はクエリ文字列を指定します。指定方法は言語に依存します
headers はHTTPヘッダに値を設定します。指定方法は言語に依存します
- post , Method
-
POSTメソッドでHTTP通信を行います
urlにはAPIリストにのいずれかのURLを指定します。 EX パイプラインを実行する場合は
/execdata はクエリ文字列を指定します。指定方法は言語に依存します
headers はHTTPヘッダに値を設定します。指定方法は言語に依存します
- put , Method
-
PUTメソッドでHTTP通信を行います
urlにはAPIリストにのいずれかのURLを指定します。 EX パイプラインを開始する場合は
/resumedata はクエリ文字列を指定します。指定方法は言語に依存します
headers はHTTPヘッダに値を設定します。指定方法は言語に依存します
- delete , Method
-
DELETEメソッドでHTTP通信を行います
urlにはAPIリストにのいずれかのURLを指定します。 EX アクションのキャッシュをクリアする場合は
/pipelinecachedata はクエリ文字列を指定します。指定方法は言語に依存します
headers はHTTPヘッダに値を設定します。指定方法は言語に依存します
ResponseResult Object
- status , Method
-
OK, Error , SystemError , Unknown のいずれかの整数値を返します
- format , Method
-
XML, Json , Html , Unknown のいずれかを示す整数値返します
- response , Method
-
それぞれのコンテントタイプに合わせたObject,結果は言語に依存します
- text , Method
-
レスポンスの文字列を返します。結果は言語に依存します
URL対応表
| Method | URL | Method | URL | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| GET |
| POST |
|
||||||||||||||||
| PUT |
| DELETE |
|
ライセンス
全てのキットはBSD ライセンスになります。
Ruby
ResponseResultのresponseは以下のコンテントタイプごとに、
- text/xml : REXML::Document
- text/javascript : eval( json.gsub(/(["'])\s*:\s*(['"0-9tfn\[{])/){"#{$1}=>#{$2}"}.gsub(/\#\{/, '\#{') )
- text/html : 文字列
Rubyの実行サンプル
#!/usr/bin/ruby
require 'asteria'
api_key = '1d1687d0-ec6e-4a78-ad66-be9c024c34f1-0deafe00f429d31e0f62ff2baaf5789d'
api = ASTERIA::Client.new( api_key , '192.168.5.165' , 25080 )
xmlresult = api.get( "/list/xml" , "" )
print "#{xmlresult.text}"
Perl
ResponseResultのresponseは以下のコンテントタイプごとに、
- text/xml : XML::DOM::Document
- text/javascript : JSON::jsonToObj()の値
- text/html : 文字列
Perlの実行サンプル
#!/usr/bin/perl
use ASTERIA::Client ;
$api_key = "1d1687d0-ec6e-4a78-ad66-be9c024c34f1-0deafe00f429d31e0f62ff2baaf5789d" ;
$apiclient = ASTERIA::Client->new( { license => $api_key , hostname => "192.168.5.165" , port => 25080 } );
$result = $apiclient->post( "/exec/xml" , { pipelineid => "pl_00001" , filename => "plrun.dat" } ) ;
$txt = $result->text ;
print "$txt" ;
Java
ResponseResultのresponseは以下のコンテントタイプごとに、
- text/xml : org.w3c.dom.Document
- text/javascript : com.infoteria.asteria.net.http.speaker.json.JSONObject
- text/html : org.w3c.dom.Document
Javaの実行サンプル
import com.infoteria.asteria.net.http.speaker.Client ;
import com.infoteria.asteria.net.http.speaker.ClientException ;
import com.infoteria.asteria.net.http.speaker.ResponseResult ;
public class Sample {
public static void main( String[] args ) throws ClientException {
String key = "1d1687d0-ec6e-4a78-ad66-be9c024c34f1-0deafe00f429d31e0f62ff2baaf5789d" ;
String host = "192.168.5.165" ;
int port = 25080 ;
Client client = new Client( key , host , port ) ;
try {
ResponseResult result = client.get( "/list/xml" , null ) ;
String text = result.getText() ;
System.out.println( text ) ;
} catch ( ClientException e ) {
e.printStackTrace() ;
}
}
}
以下の手順でパイプラインAPIのフローコンポーネントサンプルを使用できます。
- Setp１ :: Jar をflowlibにコピー
-
javaキットの中の flowpipelineapi.jar を[Install Dir]/flow/lib/flowlib 以下にコピーします。
- Setp２ :: デザイナー側で同期
-
デザイナーでコピーしたコンポーネントのファイルをダウンロードします。 ダウンロー後、デザイナーを再起動します。
- Setp３ :: フローを作成
-
- Setp４ :: フローを実行
-
実行した結果内容
PHP
ResponseResultのresponseは以下のコンテントタイプごとに、
- text/xml : 文字列
- text/javascript : 文字列
- text/html : 文字列
PHPの実行サンプル
<?php include_once 'client.php'; $apikey = "Your License Key"; $host ="192.168.5.165" ; $port = 25080 ; $apiclient = new Client( $apikey , $host , $port ) ; $result = $apiclient->get( "/list" ) ; echo $result->text ; ?>
WSH
ResponseResultのresponseは以下のコンテントタイプごとに、
- text/xml : 文字列
- text/javascript : 文字列
- text/html : 文字列
WSHの実行サンプル
<job> <script language="VBScript" src="client.vbs" /> <script language="VBScript" > Dim transport ,response set transport = new Client transport.License = "your license key" transport.Host = "192.168.5.165" transport.ContextPath = "/pipelineapi" transport.Port = 25080 Set response = transport.GetMethod( "/list" , "" ) WScript.Echo "Status : " & response.status WScript.Echo "Format : " & response.status WScript.Echo "Content : " & response.response </script> </job>
WSHの簡単なサンプル
Dim strXMLDoc
Dim intRet
Dim strURL
Dim strKey
Dim strAPI
Dim objXML
strURL = "http://yourpipelinehostname:25080/pipelineapi/exec"
strKey = "pipelineid=pl_00001"
strAPI = "your license key"
Set objXML = WScript.CreateObject("MSXML2.ServerXMLHTTP")
objXML.open "POST", strURL, False
objXML.setRequestHeader "Content-Type", " application/x-www-form-
urlencoded"
objXML.setRequestHeader "Content-Length", len(strKey)
objXML.setRequestHeader "X-PIPELINEWEBAPI", strAPI
objXML.send strKey
strXMLDoc = objXML.responseText
intRet = objXML.status
MsgBox intRet
MsgBox strXMLDoc
Set objXML = Nothing