APIアクセス数による課金
PORTERS APIへのアクセスは、認証用APIも含め、1回のRequestを1アクセスとして計測します。
イメージ図は以下の通りです。
PORTERS APIへの月間アクセス数が15万回を超えると、超過1万単位毎に月額2,000円が加算されます。
課金が発生しないよう、できるだけ効率よくレコードを取得する方法を検討してください。
1回のRequestで処理できるレコード数は、Read、Writeともに200件までです。
200件以上のデータを処理したい場合、200件ずつに区切って処理していく必要があります。
また、１分あたりのRequest上限数は、 Write APIが500件、Read APIが2,000件となります。
詳細はRequest数の制限、処理レコード数の制限をご参照ください。
尚、認証やデータの取得に失敗して以降の処理がループしてしまい、数万回の大量アクセスが発生してしまった過去事例がございます。
想定外のAPIアクセスが発生しないよう、エラー処理などを考慮した実装を行うようにしてください。
クローリングや処理のループにより、意図せずAPIアクセス数が増大してしまった場合も、課金対象となりますので、ご注意ください。
認証の有効期限
PORTERS APIの認証には有効期限があるため、認証が切れたら再認証する仕組みを入れておく必要があります。
但し、認証用APIアクセスも1アクセスとして計測されますので、できるだけ認証回数を最小にできる方法を検討してください。
日時の取り扱い
PORTERS APIで扱う日時は、UTCです。JSTではありませんので、ご注意ください。
システム停止状態に対応したアプリ構成
PORTERSならびにPORTERS APIは、システムメンテナンスやその他の理由のために停止する場合があります。
PORTERS APIを利用してアプリを開発する場合、システムが停止している場合も想定してアプリを設計しておくことは非常に重要です。
データを失わないために
PORTERS APIを利用して開発されるアプリのうち最も多いのが、求職者の登録用のページです。
通常PORTERS APIは、メンテナンスの場合を除き、無停止で運用されていますが、アプリとPORTERS APIとの接続にはインターネット回線を利用しているため、想定できない回線障害などが発生する可能性は否定できません。
万が一の場合に備えて、求職者等のデータをPORTERS APIを利用して登録する前に、ログなどに記録しておき、後で登録しなおすことができるような仕組みを取り入れておくことをお勧めします。
接続に関する注意点
PORTERS APIはWEB APIというサービス提供形態であるため、予期せず回線が切断される可能性があります。
このような状況を回避するために、重要な処理に関してはリトライをするなどして、通信障害に備えたシステム構成をとってください。
並列処理のリスク
並列処理の実行は、意図せぬエラーを引き起こす恐れがあるためお控えください。
PORTERSでの項目の変更
PORTERSでは[カスタマイズ]メニューを使用することによって、ユーザーが自由に項目や選択肢を追加したり、削除したりすることができます。
APIを使用したアプリを開発後、ユーザーが[カスタマイズ]機能を使って項目を削除した場合、プログラムで指定していた項目が存在せずにエラーになり、アプリが動作しなくなる恐れがあります。
できる限り、項目や選択肢の定義は設定ファイル等に定義し、後で変更可能な設計を行うことをお勧めします。
また、アプリ作成後に、変更してはいけない項目については、ユーザーに十分に説明し、運用時にエラーが発生しないように注意してください。
要件定義・運用開始後の保守
開発要件には、Request・Response詳細のログ管理や、不測の事態に備えたリカバリー処理などを必ず含めるようにしてください。
ポーターズ株式会社では、ユーザーのRequest・Response詳細のログは取得しておりません。
特に、外部開発会社と契約している場合は、事前に運用開始後の保守契約についても検討しておく必要があります。
ログ管理やリカバリー処理が実装されていないこと、保守担当がいないことにより発生するいかなる問題にも、ポーターズ株式会社は一切の責任を負いません。