Antcas API

アントカスAPIは、複数のアプリケーション間でデータを交換することを可能にします。

警告: このAPIを使用する際のセキュリティに注意してください。TLSのみを使用し、ポートを公開アドレスで決して使用しないでください。

注意: APIは各呼び出し時にトークンを確認する必要があるため、システム負荷が高くなる可能性があります。

APIポートの設定

プロジェクト管理の下で、新しいAPIポートを追加できます。説明はポートをプロジェクトに割り当てるの章で見つかります。

要求が作成されるには、トークンを使用して認証する必要があります。トークンの作成についてはトークンを管理するの章で詳しく説明されています。

形式と値

APIは複数の入力形式をサポートしています: HTTPクエリ、JSON、XML。出力はHTML、テキスト、JSONまたはXMLで行われることができます。文字コードは常にUTF-8です。

注意: ブラウザ内の要素による呼び出しはエラー428（Precondition Required）を引き起こします。これはXSS攻撃防止であり、回避することはできません。これによりアントカスコントロールへのハッキング攻撃が防止されます。

POSTまたはPUT要求では、データは対応する形式でコンテンツに記述できます。各変数は大文字と小文字を区別します。これは大文字と小文字を区別することを意味します。ただし、返信は常に宣言された形式で行われます。出力形式はヘッダーまたは変数formatを介して記述できます。入力形式は常に自動的に認識されます。

GET /visu/var/eid?format=json&token=tokenid HTTP/1.1
Host: serveraddr.com
Content-Type: application/json

次の形式がヘッダーと変数formatでサポートされています:

Content-Type Variable Format
application/json json JSON
application/xml xml XML
text/plain text テキスト
text/csv csv CSV*
(その他) html HTML

*出力形式としてのみサポートされています。

注意: テキストとCSVの形式にはUTF-8 BOMが含まれます。これは変数bom=FALSEを使用して無効にできます。

複数の形式で値が記述される場合、後者の形式が優先されます:

  • HTTPヘッダー（出力形式のみContent-Type経由）
  • GET
  • POST
  • JSON/XML（POSTまたはPUTコンテンツとして）

入力変数

次の変数はグローバルに定義されています。

Variable 説明
format 出力形式。
bom UTF-8形式のBOM。デフォルトはTRUEです。
key 宣言された変数のみを読み取ります。このメソッドは非効率的であり、すべてのデータが準備されてからフィルタリングされるためです。これは小さなデータ量でのみ使用する必要があります。
header ヘッダーを出力します。デフォルトはTRUEです。
compact すべてのサブ要素を統合します。ブール値が宣言されていない場合、この値は変数を統合するために使用されます。それ以外の場合、値.が使用されます。
values 変数名ではなく値のみを返します。このオプションはHTML、CSV、テキストでのみ利用可能です。
minimal header=FALSE, compact=minimalおよびvalues=TRUEのエイリアスです。
csvdel CSV区切り文字。デフォルトは;です
csvenc CSV囲み括弧。デフォルトは"です
csvesc CSVエスケープ文字。デフォルトは\です

次の変数はグローバルに、また個々の変数にも使用できます。単一の変数を指定するには、次のように定義します:

time*:hr=true

上記の例では、すべてのtimeで始まる変数とtime自体が対象となります。規則は順番に確認されます。したがって、最後の一致する規則が優先されます。正規表現を使用して検索します。

Variable 説明
hr 人間が読みやすい形式。可能な場合、変数は人間が読みやすいデータに変換されます。デフォルトはHTML、CSV、テキストの形式でTRUEです。
numdec 小数点以下の桁数。
numths 千の位区切り文字。
numdot 小数点記号。
prefix 変数の前にテキストを追加します。
suffix 変数の後にテキストを追加します。

パス

下記の章では、APIのすべてのアプリケーションが定義されています。

サブページ