APIリファレンス (1.0.4)

Download OpenAPI specification:Download

hacoCMS APIリファレンス
https://hacocms.com

Authentication

Bearer

APIアクセスに必要なトークン

Security Scheme Type HTTP
HTTP Authorization Scheme bearer

コンテンツ

コンテンツに関するAPIです。
シングル形式とリスト形式で、パスが異なる部分があります。

コンテンツ一覧取得

コンテンツの一覧を取得します。
シングル形式の場合は、コンテンツ単体を取得します。
詳細は"GET /api/v1/{endpoint}/{content_id}"を参照してください。

Authorizations:
path Parameters
endpoint
required
string <string>
Example: endpoint

エンドポイント

query Parameters
q
string <string>
Example: q=pet[eq]:cat[+]createdAt[ge]:2021-10-01

検索フィルタークエリ
書式: q={field_id}[{述語}}]:{value}[+]...

  • URLエンコード必須
  • [+]でAND条件
    条件 パラメータ
    = eq pet[eq]:cat
    != ne pet[ne]:dog
    < lt age[lt]:30
    <= le age[le]:30
    > gt age[gt]:50
    >= ge createdAt[ge]:2021-10-01
    IN in rank[in]:S,A
    LIKE cont article[cont]:観光
    START_WITH start title[start]:おすすめ
    END_WITH end title[end]:ランキング
    入力済 entered extraDesc[entered]
    未入力 not_entered middleName[not_entered]
ids
string <string>
Example: ids=unique-value-01,unique-value-02

複数コンテンツID指定クエリ
書式: ids={content_id},{content_id}...

  • 最大100件まで指定可能です。
limit
integer <int64>
Example: limit=100

取得件数を指定します。デフォルト値は100です。

offset
integer <int64>
Example: offset=100

取得開始位置を指定します。デフォルト値は0です。

search
string <string>
Example: search=天気

通常検索
JSON全体を検索します。meta情報は対象外です。

s
string <string>
Example: s=title,-updatedAt

ソートクエリ
書式: s={sign}{field_id},{sign}...

  • sign: "-"のみ指定可能(未指定は昇順・指定は降順)
  • 日付・真偽値・数値以外の型は文字列として比較されます。
status
integer <int64>
Example: status=0

ステータス

header Parameters
Haco-Project-Draft-Token
string <string>
Example: project-draft-token

未公開コンテンツを含めた一覧を取得するためのトークン

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

コンテンツ投稿

コンテンツを投稿します。

Authorizations:
path Parameters
endpoint
required
string <string>
Example: endpoint

エンドポイント

header Parameters
Haco-Write-Token
required
string <string>
Example: haco-write-token

コンテンツを投稿・編集・削除するためのトークン

Request Body schema: application/json

リクエストオブジェクト

field
string <string>

key、value、型はフィールド毎に異なる

Responses

Request samples

Content type
application/json
{
  • "field": "field-value"
}

コンテンツ投稿 (シングル形式のみ)

コンテンツを投稿します。投稿済みの場合は編集します。

Authorizations:
path Parameters
endpoint
required
string <string>
Example: endpoint

エンドポイント

header Parameters
Haco-Write-Token
required
string <string>
Example: haco-write-token

コンテンツを投稿・編集・削除するためのトークン

Request Body schema: application/json

リクエストオブジェクト

field
string <string>

key、value、型はフィールド毎に異なる

Responses

Request samples

Content type
application/json
{
  • "field": "field-value"
}

コンテンツ編集 (シングル形式のみ)

コンテンツの内容を編集します。
"PATCH /api/v1/{endpoint}/{content_id}"でも可能です。

Authorizations:
path Parameters
endpoint
required
string <string>
Example: endpoint

エンドポイント

header Parameters
Haco-Write-Token
required
string <string>
Example: haco-write-token

コンテンツを投稿・編集・削除するためのトークン

Request Body schema: application/json

リクエストオブジェクト

field
string <string>

key、value、型はフィールド毎に異なる

Responses

Request samples

Content type
application/json
{
  • "field": "field-value"
}

コンテンツ削除 (シングル形式のみ)

コンテンツを削除します。
"DELETE /api/v1/{endpoint}/{content_id}"でも可能です。

Authorizations:
path Parameters
endpoint
required
string <string>
Example: endpoint

エンドポイント

header Parameters
Haco-Write-Token
required
string <string>
Example: haco-write-token

コンテンツを投稿・編集・削除するためのトークン

Responses

コンテンツ取得

指定したコンテンツを取得します。

Authorizations:
path Parameters
endpoint
required
string <string>
Example: endpoint

エンドポイント

content_id
required
string <string>
Example: content-id

コンテンツID

query Parameters
draft
string <string>
Example: draft=draft-token

未公開コンテンツを取得するためのトークン

header Parameters
Haco-Project-Draft-Token
string <string>
Example: project-draft-token

未公開コンテンツを含めた一覧を取得するためのトークン

Responses

Response samples

Content type
application/json
{
  • "id": "unique-value",
  • "field": "field-value",
  • "createdAt": "created-at",
  • "updatedAt": "updated-at",
  • "publishedAt": "published-at",
  • "closedAt": "closed-at"
}

コンテンツ投稿

指定したIDでコンテンツを投稿します。投稿済みの場合は編集します。

Authorizations:
path Parameters
endpoint
required
string <string>
Example: endpoint

エンドポイント

content_id
required
string <string>
Example: content-id

コンテンツID

header Parameters
Haco-Write-Token
required
string <string>
Example: haco-write-token

コンテンツを投稿・編集・削除するためのトークン

Request Body schema: application/json

リクエストオブジェクト

field
string <string>

key、value、型はフィールド毎に異なる

Responses

Request samples

Content type
application/json
{
  • "field": "field-value"
}

コンテンツ編集

指定したコンテンツの内容を編集します。

Authorizations:
path Parameters
endpoint
required
string <string>
Example: endpoint

エンドポイント

content_id
required
string <string>
Example: content-id

コンテンツID

header Parameters
Haco-Write-Token
required
string <string>
Example: haco-write-token

コンテンツを投稿・編集・削除するためのトークン

Request Body schema: application/json

リクエストオブジェクト

field
string <string>

key、value、型はフィールド毎に異なる

Responses

Request samples

Content type
application/json
{
  • "field": "field-value"
}

コンテンツ削除

指定したコンテンツを削除します。

Authorizations:
path Parameters
endpoint
required
string <string>
Example: endpoint

エンドポイント

content_id
required
string <string>
Example: content-id

コンテンツID

header Parameters
Haco-Write-Token
required
string <string>
Example: haco-write-token

コンテンツを投稿・編集・削除するためのトークン

Responses