クラウド見積請求書作成ソフトTOP > ブログ > マニュアル > 7-2.APIの仕様(各機能共通部分)
2024.12.09 

7-2.APIの仕様(各機能共通部分)

共通

URLの指定

URLの指定 : https://cloudpaper.net/c/api/機能名.php

APIキーの指定及び認証

APIの認証は、APIキーをHTTPSによるAPIリクエスト時に付与することにより行います。
APIキーは管理画面より取得します。
取得可能なAPIキーは1契約につき、1つです。APIの再発行は可能です。
APIキーによるアクセスに、IPアドレス制限を付与する事も可能です。
取得したAPIキーはHTTPリクエストヘッダーに付与して使用します。
  以下の通りリクエストヘッダーに含める形式でAPIキーを渡します。

項目名 日本語名 説明
apikey APIキー APIキーの発行で発行したAPIキー
curlコマンドの例)
APIキー”xxxxxx-xxxxxx-xxxxxx-xxxxxx-xxxxxx”の場合の請求書削除のリクエストの例は下記の通り
curl -X POST -i -H “apikey : xxxxxx-xxxxxx-xxxxxx-xxxxxx-xxxxxx” -d ‘{“seikyu_id”:”3″}’
https://cloudpaper.net/c/api/clientdelete.php

エラーデータの仕様(json形式)

正常終了の場合のレスポンス・・・ステータス=200
json形式のデータの戻り値は各機能の項目に記述しています。

エラーの場合のレスポンス・・・ステータス=400

項目名 日本語名 説明
status_code ステータスコード 400
errors エラー
messages メッセージ 日本語のエラーメッセージが表示されます。
type タイプ

SHARE

請求書の作成をもっとカンタンに!フリーランス・中小企業向けアプリ

見積請求書の作成・管理ができるCLOUD PAPER
WindowsでもMacでも、無料ではじめることができます!

一覧へ戻る