システム概要

認証方式

API共通処理

HTTPステータスコード

レスポンスとして返却するコードは以下とする

code	意味	説明
200	ok	正常に処理が行われた場合に返却する
201	created	新規作成処理が正常に行われた場合に返却する
202	Accepted	リクエストが正常に受付された場合に返却する
304	Not Modified	リクエストされたリソースを再送する必要がない場合に返却
400	Bad Request	リクエストが不正な場合に返却する
401	Unauthorized	認証エラーの場合に返却する
402	Payment Required	決済情報が必要であったり、課金上限を超えてしまった場合に返却する
403	Forbidden	リソースへのアクセス権限がない場合に返却する
404	Not Found	リソースが存在しない場合に返却する
405	Method Not Allowed	HTTPメソッド（GET/POST/PUT/DELETE/OPTIONS/HEADなど）が許可されていない場合に返却する
406	Not Acceptable	リクエストヘッダー情報が間違っている場合に返却する
408	Request Timeout	CAREKARTEサーバーから25秒以上レスポンスがない場合に返却
409	Conflict	更新がバッティングしたり、ユニークなIDが重複してしまった場合に返却する
500	Internal Server Error	例外エラーが発生した場合に返却する
502	Bad Gateway	アプリケーションサーバが落ちている時に返却する
503	Service Unavailable	アプリケーションサーバ側で何らかのシステムエラーが発生した場合に返却する
504	Gateway Timeout	アプリケーションサーバからレスポンスがなくタイムアウトした場合に返却する

連携開発の進め方（NDA締結以降）

No	作業内容	作業者	備考
1	NDA締結	CCJ、パートナー
2	開発部門打合せ	CCJ、パートナー
3	パートナーコンソールのアカウント発行	CCJ	APIの仕様ページを公開しています
4	ステージング(テスト)環境のご提供	CCJ
	テスト用CAREKARTEのご案内		自由に操作いただけるCAREKARTEの環境をご提供いたします
	テスト用CAREKARTEのAPIキーを発行		御社テスト用CAREKARTEへアクセスするためのAPIキーを発行いたします
5	テスト接続	パートナー	まずはAPIキーとパスワードでTokenが取得できることをご確認ください
6	連携仕様の検討	パートナー	CAREKARTEへのカスタマイズ等も併せて検討させていただきたいので、
			CCJの運用支援部門も参加させていただき連携仕様検討のお打ち合わせをさせてください
7	開発	パートナー	お問い合わせについてはパートナーコンソールのお問い合わせ機能をご活用ください
8	開発完了	パートナー	連携開発が完了しましたら、CCJまでご連絡ください
9	連携仕様のご共有および連携デモ	パートナー	CCJからお伺いする連携仕様をご共有ください、また各部門参加させていただき連携デモの実施をお願いしております
10	リリースプロジェクト	CCJ	開発された連携仕様をご共有ください、リリースに向けて弊社内の準備を進めます
11	CAREKARTE Link使用許諾契約	CCJ、パートナー	ユーザーさま本稼働前に、ご契約お願いいたします（雛型については事前にお渡し可能です）
12	本番環境(ユーザー)連携開始可能	CCJ、パートナー	ユーザーさまに連携オプションのご購入をいただいてからAPIキーを発行いたします