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

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

共通

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

 

APIキーの指定

・リクエストヘッダーに含める形式で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

 

・正常終了の場合のレスポンス

ステータス=200

json形式のデータの戻り値は各機能の項目に記述しています。

 

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

json形式のデータ

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

SHARE
このエントリーをはてなブックマークに追加

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

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

一覧へ戻る