ここでは、PORTERS APIで使われる用語を説明します。
- ユーザーアプリ
- サードパーティアプリ
- アプリ名
- App ID
- Secret
- Redirect URL
- APIアクセス数
- Partition（パーティション）
- Resource（リソース）
- Field（フィールド）
- Option（オプション）
ユーザーアプリ
PORTERSユーザー企業が、自身の用途に沿って開発するアプリを指します。
例えば、PORTERSと自社サイトを連携するためのアプリなどです。
サードパーティアプリ
ポーターズ株式会社、PORTERSユーザー企業が開発したアプリではなく、第三者が開発するアプリを指します。
例えば、外部求人媒体へのエントリー情報をPORTERSに連携するためのアプリなどです。
アプリ名
個々のアプリを判別するための名称です。
特にご指定がない場合は、ポーターズ株式会社にて「会社ID_api」といった名称を登録します。
サードパーティアプリなどの場合、アプリ一覧画面に表示される名称でもあります。
App ID
個々のアプリを判別するためのIDです。
API認証時に利用します。
ポーターズ株式会社にてアプリ登録を行った際に発行され、任意設定や変更はできません。
尚、本サイト内の例では、App ID=ABCとして説明します。
Secret
個々のアプリに対して発行される認証パスです。
API認証時に利用します。
ポーターズ株式会社にてアプリ登録を行った際に発行され、任意設定はできません。
但し、再発行（変更）は可能です。
例えば、外部開発会社を変更する場合などは、セキュリティ担保のため変更することをお勧めしております。
尚、本サイト内の例では、Secret=XYZとして説明します。
Redirect URL
APIお申込み時に、PORTERS契約ユーザーからの指定が必須です。
アプリを実行するサーバーのURLを、Redirect URLとして登録します。
ホスト部分をIPで指定することは可能ですが、必ずURLの形式での登録が必要になります。
API認証時に利用します。
尚、本サイト内の例では、Redirect URL=http://myapplication.comとして説明します。
APIアクセス数
APIアクセス数は、ページビューの回数や求人の件数ではなく、APIに何回アクセス（request）したかを数えております（認証のためのRequest含む）。
情報取得するために何回のAPIアクセスを必要としているかによりAPIアクセス数は大幅に変わります。
例）
・閲覧者がページを開く度にAPIアクセスを行って情報を取得する（アクセス数多）
・数時間に一度定期的にAPIアクセスを行って情報を取得し自社DBに貯めておく（アクセス数少）
プログラムによってどのようにAPIアクセスを行っているかが異なりますが、プログラム詳細につきましてはポーターズ株式会社ではわかりかねますので、開発ご担当者様へご確認ください。
Partition (パーティション)
PORTERSでは、個々の会社データを独立したデータ単位で管理しています。
この独立した会社データの単位をPartitionと呼びます。Company DBと呼ばれることもあります。
Resource (リソース)
Partitionの中に保存される、各種データのことをResourceと呼びます。
例えば、「個人連絡先」に関するデータであればCandidate Resource、「JOB」に関するデータであれば、Job Resourceと呼びます。
これらのResourceにアクセスするAPIのことをResource APIと呼びます。
Resourceは、PORTERSの情報と次のような対応関係があります。
| Resource名 | PORTERSデフォルトメニュー名（任意変更可） | |
|---|---|---|
| PORTERS Agent（紹介向け） | PORTERS Staffing（派遣向け） | |
| Client | 企業 | 企業 |
| Recruiter | 企業担当者 | 企業担当者 |
| Job | JOB | 案件 |
| Candidate | 個人連絡先 | スタッフ連絡先 |
| Resume | レジュメ | スタッフ |
| Process | 選考プロセス | 引当/就業管理 |
| Activity | アクティビティ | アクティビティ |
| Contract | 契約 | 契約 |
| Sales | 成約（売上） | 個別契約 |
※参考：PORTERSユーザー向けヘルプ：PORTERSのデータ構造
Field(フィールド)
Resourceの中に定義されている項目をFieldと呼びます。
各Reousceへのアクセス時に、どの項目に対して読み込みまたは書き込みするかを、Fieldを指定して取得します。
Option(オプション)
Optionは選択肢を定義するマスタデータです。
選択肢型のFieldには、選択肢としてOptionが関連付けられます。
選択肢型Fieldでは、関連づけられたOptionの選択肢から、単一選択または複数選択を行うことができます。