SheetX API仕様 (1.0)

Download OpenAPI specification:Download

SheetXのAPIドキュメントです。

本APIを使用することで、帳票出力を簡単に実装できます。

sheets

帳票関連API

帳票を新規作成

帳票テンプレートと入力データを受け取り、帳票を新規作成します。帳票に記載するデータを指定するvaluesは、帳票テンプレート毎に異なります。ダッシュボードを確認してください。

Authorizations:

api-key

Request Body schema: application/json

response_type required	string Default: "url" Enum: "url" "base64" APIのレスポンス形式を指定します。
required	Array of objects sheetオブジェクトの配列。ページ1枚を1つの要素として指定します。

Responses

Request samples

Payload

Content type

application/json

{"response_type": "url",
"sheets": [{"template_id": "f0fac17b-a95b-4712-a15e-d24898a0e6f2",
"page_number": 1,
"values": {"company_name": "株式会社ABC",
"company_tel": "123-456-7890",
"email": "test@exmaple.com"
}
},
{"template_id": "d912e558-0a04-11ee-be56-0242ac120002",
"page_number": 2,
"values": {"item_1": "りんご",
"item_2": "ぶどう",
"item_3": "オレンジ"
}
}
]
}

Response samples

200

Content type

application/json

Example

response_type url

{"url": "https://example.com/1234567890",
"url_expiration": 300
}