API エンティティにアクセスするユーザーを認証トークンで認証することができます。以下に示すように、HTTP 認証で認証トークンを提供します。ユーザーおよび許可されたIP アドレスの管理は管理コンソールの［サービス］タブで行います。

また、API を呼び出す前に、［設定］->［サービス］で、特定のIP アドレスを接続できるようにする必要があります。デフォルトでは、すべてのIP アドレスは許可されています。

Basic 認証で認証トークンを使用する

Basic 認証では、ユーザーの認証トークンはパスワードとして使われます。

HTTP ヘッダーで認証トークンを使用する

HTTP ヘッダー “x-cdata-authtoken” を希望する認証トークンとともにHTTP リクエストとして追加します。

クエリ文字列パラメータとして認証トークンを使用する

HTTP フォームポストデータ、もしくはクエリパラメータの一部として提供される_@authtoken_ パラメータの値として認証トークンを指定することができます。ただし、デフォルトではAPI Server はクエリ文字列パラメータにおいて認証トークンを渡すことをサポートしていません。

settings.cfg ファイルのアプリケーションセクションにて、次のオプションを設定することで有効化できます。

[Application]
AllowAuthtokenInURL = true

.NET

CData API Server の2021 バージョンから、settings.cfg ファイルはC:\ProgramData\CData\apiserver\ に配置されます。

バージョン2020以前では、settings.cfg ファイルはアプリケーションルートのapp_data サブフォルダに格納されます。2021より前のバージョンからアップグレードされたインストールでは、引き続きこの場所が使用されます。デフォルトはC:\Program Files\CData\CData API Server\www\app_data\ です。

Java

Java 版では、これはデータディレクトリに配置されています。データディレクトリの位置は、OS によって異なります。

• Windows: C:\ProgramData\CData
• Unix or Mac OS X: ~/cdata