NILTO Developer APIリファレンス (1.0.3)

https://cms-api.nilto.com/v1

認証のためにAPIキーをリクエストヘッダーに含めて送信してください。 スペース設定のAPIキー画面で取得することができます。

key	value
X-NILTO-API-KEY	APIキー

APIキーには、公開コンテンツのみ取得できるAPIキーと、下書きも含めて取得できるAPIキーがあります。用途に合わせて使い分けてください。

基本

モデルがnewsであるコンテンツ一覧を50件目から最大10件を取得

/contents?model=news&offset=50&limit=10

上記のレスポンス例:

{
  "total": 345,
  "offset": 50,
  "limit": 10,
  "data": [
    {
      "_id": 1234567890,
      "_model": "news",
      "_title": "Hello World",
      "_created_at": "2023-01-23T04:50:00Z",
      "_updated_at": "2023-01-23T04:50:00Z",
      "_published_at": "2023-01-23T04:50:00Z",
      "_status": "published",
      "field1": "value1",
      "field2": "value2"
    },
          ︙
  ]
}

コンテンツ参照フィールドcategoryで、IDが1234567890のコンテンツを参照しているコンテンツ一覧を取得

/contents?category[eq]=1234567890

日時を指定してコンテンツ一覧を取得

日時はISO 8601拡張形式で指定します。

更新日時が日本時間で2023年1月23日4時よりも新しいコンテンツの配列を取得

/contents?_updated_at[gt]=2023-01-23T04:00:00+09:00

上記と同じ日時をUTC時間（2023年1月22日19時）で指定する場合

/contents?_updated_at[gt]=2023-01-22T19:00:00Z

キーワード検索でコンテンツ一覧を取得

特定のフィールドに指定したキーワードを含むコンテンツ一覧を取得する場合、containsフィルターを使用します。

フレキシブルテキストフィールドbodyにkeywordを含むコンテンツの配列を取得

/contents?body[contains]=keyword

複数のキーワードをAND検索

/contents?body[contains]=keyword1,keyword2

フィールドセット内フィールドに対して条件指定してコンテンツ一覧を取得

フィールドセット内のフィールドは、フィールドセットLUIDとフィールドLUIDを.で連結して指定できます。

例: フィールドセットfield_set内のフィールドtextの内容がabcであるコンテンツ一覧を取得

/contents?field_set.text[eq]=abc

参照コンテンツのフィールドに対して条件指定してコンテンツ一覧を取得

参照しているコンテンツのフィールドは、フィールドLUIDを.で連結して指定できます。

例: コンテンツ参照フィールドcategoryで参照しているコンテンツのフィールドkeyの内容がreleaseであるコンテンツ一覧を取得

/contents?category.key[eq]=release

コンテンツIDが1234567890のコンテンツを取得

/contents/1234567890

上記のレスポンス例:

{
  "_id": 1234567890,
  "_model": "news",
  "_title": "Hello World",
  "_created_at": "2023-01-23T04:50:00Z",
  "_updated_at": "2023-01-23T04:50:00Z",
  "_published_at": "2023-01-23T04:50:00Z",
  "_status": "published",
  "field1": "value1",
  "field2": "value2"
}

depthパラメータを使用することで、参照するコンテンツのオブジェクトを取得する再帰深度を変更することができます。指定より深い参照は、オブジェクトではなくコンテンツIDになります。

コンテンツ参照フィールドのオブジェクトを取得しない場合

/contents/1234567890?depth=0

上記のレスポンス例:

{
  "_id": 1234567890,
  "content_reference": 2345678901
}

コンテンツ参照フィールドのオブジェクトを1階層まで取得する場合（デフォルト動作）

/contents/1234567890?depth=1

上記のレスポンス例:

{
  "_id": 1234567890,
  "content_reference": {
    /* 参照1階層目 */
    "_id": 2345678901,
    "content_reference": 3456789012
  }
}

コンテンツ参照フィールドのオブジェクトを3階層まで取得する場合

/contents/1234567890?depth=3

上記のレスポンス例:

{
  "_id": 1234567890,
  "content_reference": {
    /* 参照1階層目 */
    "_id": 2345678901,
    "content_reference": {
      /* 参照2階層目 */
      "_id": 3456789012,
      "content_reference": {
        /* 参照3階層目 */
        "_id": 4567890123,
        "content_reference": 5678901234
      }
    }
  }
}

APIのリクエストパラメーターで、特定のオブジェクトを指定するとき、IDもしくはLUIDを使用します。

IDはシステムが定義する、グローバルでユニークなIDです。ユーザーが変更することはできません。

LUID (Locally Unique Identifier) はユーザーが定義するIDです。モデル/フィールドセットのLUIDはスペース内でユニークです。フィールドLUIDはモデル/フィールドセット内でユニークです。

オブジェクトごとの指定方法は以下になります。

オブジェクト	指定方法	変更	確認方法
モデル	LUID	可	モデル詳細ページ > 基本情報ダイアログ
フィールドセット	LUID	可	フィールドセット詳細ページ > 基本情報ダイアログ
フィールド	LUID	可	モデル（フィールドセット）詳細ページ > フィールド詳細ペイン
コンテンツ	ID	不可	コンテンツ詳細ペイン > API出力確認ダイアログ

アーカイブされたコンテンツは、Developer APIで取得することはできません。 アーカイブされたコンテンツやメディアを参照しているフィールドは、値が空になります。

サブスペース機能をご利用のスペースの場合、レスポンスに_spaceキーが含まれます。

値はスペースのLUIDで、親スペースの場合は_parentが固定で設定されています。

/contents?model=news&select=_id,_model,_title,_status,field1

上記のレスポンス例:

{
  "total": 345,
  "offset": 0,
  "limit": 100,
  "data": [
    {
      "_id": 1234567890,
      "_model": "news",
      "_title": "Hello World",
      "_space": "_parent",
      "field1": "value_1",
    },
    {
      "_id": 1234567891,
      "_model": "news",
      "_title": "Sample Demo News",
      "_space": "demo",
      "field1": "value_2",
    },
          ︙
  ]
}

スペースの絞り込み

スペースLUIDがdemoのスペース内コンテンツのみ取得したい場合、spaceキーを指定します。

/contents?model=news&select=_id,_model,_title,_status,field1&space=demo

上記のレスポンス例:

{
  "total": 123,
  "offset": 0,
  "limit": 100,
  "data": [
    {
      "_id": 1234567891,
      "_model": "news",
      "_title": "Sample Demo News",
      "_space": "demo",
      "field1": "value_2",
    },
          ︙
  ]
}

Developer APIの品質を担保するため、リクエストは以下の値で制限されます。この制限はAPIキーごとに適用されます。

• GET APIのレートリミット: 600回 / 1分
• 書き込み API（POST / PUT / PATCH / DELETE）のレートリミット: 30回 / 1分

この制限を超えたリクエストは429エラーになります。このとき、次のリクエストが可能になるまでの秒数がretry-afterヘッダーで返されます。

Developer APIに関する既知の不具合は以下のとおりです。

• サブ言語の翻訳しないフィールドに対してフィルター条件を指定したとき、正しくフィルタリングされないことがある。
• フィルター条件を指定したとき、APIキーが対象とするステータス以外のコンテンツの内容でヒットしてしまう。

フレキシブルテキスト

flexibletext_field[format]=htmlを指定した場合（デフォルト動作）

"flexibletext_field": "<div><h2>abcedf</h2><p>abcedf</p><ul><li>abcedf</li></ul></div>"

flexibletext_field[format]=textを指定した場合

"flexibletext_field": "abcedf\r\nabcedf\r\nabcedf"

1行テキスト

"singleline_field": "foobar"

複数行テキスト

"multiline_field": "foobar\r\nfoobar"

ブーリアン

"boolean_field": true

単一選択

"singleselect_field": "value"

複数選択

"multiselect_field": [
  "value1",
  "value2",
  "value3"
]

日時

"datetime_field": "2023-01-23T04:50:00Z"

メディア

"media_field": {
  "url": "https://cms-assets.nilto.com/spaces/1234567890/media/2345678901/_/abc.png",
  "alt": "alternative text"
}

コンテンツ参照

"reference_field": {
  "_id": 2345678901,
  "_title": "Hello World2",
  "_created_at": "2023-01-23T04:50:00Z",
  "_updated_at": "2023-01-23T04:50:00Z",
  "_published_at": "2023-01-23T04:50:00Z",
  "_status": "published",
  "singleline_field": "foobar"
}

繰り返し

繰り返しは、フィールドの集合であるオブジェクトの配列で表現されます。

"repeat_field": [
  {
    "singleline_field": "foo",
    "boolean_field": true
  },
  {
    "singleline_field": "foobar",
    "boolean_field": false
  },
  {
    "singleline_field": "foobarbaz",
    "boolean_field": true
  }
]

組み合わせ

組み合わせは、フィールドセットのデータであるオブジェクトの配列で表現されます。 フィールドセット内のluidは指定したLUIDです。fieldsはフィールドセット内フィールドです。

"combination_field": [
  {
    "luid": "field_set_a",
    "fields": {
      "singleline_field": "foo",
      "boolean_field": true
    }
  },
  {
    "luid": "field_set_b",
    "fields": {
      "datetime_field": "2023-01-23T04:50:00Z",
      "singleselect_field": "value"
    }
  },
  {
    "luid": "field_set_a",
    "fields": {
      "singleline_field": "foobar",
      "boolean_field": false
    }
  }
]

フィールドセット（モデルに直接組み込んだ場合）

"field_set": {
  "singleline": "foobar",
  "boolean": true
}

コンテンツ一覧取得APIのフィルターについて、指定できる値は以下になります。

フィールド種類	[eq]	[in]	[lt]	[lte]	[gt]	[gte]	[contains]	[has]
フレキシブルテキスト	N/A	N/A	N/A	N/A	N/A	N/A	文字列	N/A
1行テキスト	文字列	文字列	N/A	N/A	N/A	N/A	文字列	N/A
複数行テキスト	文字列	文字列	N/A	N/A	N/A	N/A	文字列	N/A
ブーリアン	true/false	N/A	N/A	N/A	N/A	N/A	N/A	N/A
単一選択	文字列	文字列	N/A	N/A	N/A	N/A	N/A	N/A
複数選択	N/A	N/A	N/A	N/A	N/A	N/A	N/A	文字列
日時	N/A	N/A	日時	日時	日時	日時	N/A	N/A
メディア	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A
コンテンツ参照	コンテンツID	コンテンツID	N/A	N/A	N/A	N/A	N/A	N/A
繰り返し	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A
組み合わせ	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A
フィールドセット	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A

ベータ版機能について

この機能はベータ版での提供となっており、動作が不安定な場合があります。
また、今後互換性を保たない変更が加わる可能性があります。

あらかじめご了承いただいた上でのご利用をお願いいたします。

フレキシブルテキスト

※現在、フレキシブルテキストは未対応です。

1行テキスト

任意の文字列を指定してください。

"fields": {
  "singleline_field": "foobar"
}

複数行テキスト

任意の文字列を指定してください。改行コードを使用することができます。

"fields": {
  "multiline_field": "foobar\r\nfoobar"
}

ブーリアン

真偽値を指定してください。

{
  "fields":{
    "{LUID}":true
  }
}

単一選択

フィールドに設定した値を指定してください。「表示名」ではなく「値」を指定してください。

{
  "fields":{
    "{LUID}":"value"
  }
}

複数選択

※現在、複数選択は未対応です。

日時

日時をISO 8601拡張形式で指定してください。

{
  "fields":{
    "{LUID}":"2023-01-23T04:50:00Z"
  }
}

メディア

メディアのIDを指定してください。

{
  "fields":{
    "{LUID}":123456789
  }
}

コンテンツ参照

参照先コンテンツのIDを指定してください。

{
  "fields":{
    "{LUID}":123456789
  }
}

繰り返し

繰り返しフィールドを配列で指定してください。 配列内は各フィールドをオブジェクト形式で指定してください。

{
  "fields":{
    "{繰り返しのLUID}":[
      {
        "{内包フィールドのLUID}":"1行テキスト",
        "{内包フィールドのLUID}":"複数行テキスト\n複数行テキスト"
      },
      {
        "{内包フィールドのLUID}":"1行テキスト",
        "{内包フィールドのLUID}":"複数行テキスト\n複数行テキスト"
      }
    ]
  }
}

フィールドセット

フィールドセット内の各フィールドをオブジェクト形式で指定してください。

{
  "fields":{
    "{フィールドセットのLUID}": {
      "{内包フィールドのLUID}":"1行テキスト",
      "{内包フィールドのLUID}":"複数行テキスト\n複数行テキスト"
    },
  }
}

組み合わせ

組み合わせに設定されたフィールドセットを配列で指定してください。 フィールドセットは"luid"にフィールドセットのLUIDを指定し、 "fields"にフィールドセット内の各フィールドをオブジェクト形式で指定してください。

{
  "fields":{
    "{組み合わせのLUID}":[
      {
        "luid":"{フィールドセットのLUID}",
        "fields":{
          "{内包フィールドのLUID}":"1行テキスト",
          "{内包フィールドのLUID}":"複数行テキスト\n複数行テキスト"          
        }
      },
      {
        "luid":"{フィールドセットのLUID}",
        "fields":{
          "{内包フィールドのLUID}":"1行テキスト",
          "{内包フィールドのLUID}":"複数行テキスト\n複数行テキスト"          
        }
      }
    ]
  }
}

ベータ版機能について

この機能はベータ版での提供となっており、動作が不安定な場合があります。
また、今後互換性を保たない変更が加わる可能性があります。

あらかじめご了承いただいた上でのご利用をお願いいたします。