HireHopはAPIの上に構築されています。つまり、HireHopが行うことはすべて、広範なAPIを使用して実行することもできます。 Rest APIにアクセスするために必要なのは、関連するURLエンドポイントにGETまたはPOSTとして適用されるユーザートークンだけです。

APIトークン

APIトークンを生成するには、[設定]ページに移動し、[ユーザー]タブを選択します。ユーザーを選択または作成し、その特定のユーザーを選択した状態で、[メニュー]ボタンをクリックし、[APIトークン]オプションをクリックしてトークンを生成します。トークンが表示され、コピーボタンを使用してクリップボードにコピーできます。

選択したユーザーのメールアドレスまたはパスワードを変更した場合、またはその後そのユーザーにログインした場合、トークンは無効になります。これを防ぐには、専用のAPIユーザーを作成し、セキュリティのために関連する権限を付与して、APIを使用しないものからユーザーを制限する必要があります。

セキュリティ上の理由から、フロントエンドのJavaScriptコードでトークンを使用しないでください。ハッカーがトークンを取得した場合、HireHopのデータを変更してアクセスできるため、トークンは秘密にしてください。サーバー側でのみ使用してください。トークンが漏洩した場合は、APIユーザーのパスワードを変更して新しいトークンを生成するだけです。

トークンの使用

トークンは、「トークン」と呼ばれるGETまたはPOSTパラメーターとして設定する必要があります。たとえば、ジョブ番号52のジョブデータをロードするために、HireHopはAPIエンドポイントを呼び出します。

https://myhirehop.com/php_functions/job_refresh.php?job=52

トークンを使用して同じエンドポイントを呼び出す場合、URLは次のようになります。

https://myhirehop.com/php_functions/job_refresh.php?job=52&token=dqwejk5GVT65909bHHBN7922pq5hxjm%207hmn

GET(上記のようなURLパラメーター)を介してトークンを渡す場合は、最初にhttps://meyerweb.com/eric/tools/dencoderなどのツールを使用してトークンをエンコードする必要があることに注意してください。

データの投稿

HireHopでデータを作成または編集するには、POSTを使用する必要があります。データを投稿するときは、変更するフィールドのみを設定する必要があります。たとえば、エンドポイントhttps://myhirehop.com/php_functions/job_save.phpを使用してジョブを作成または編集し、パラメータ「job」を「0」に設定します。 “またはそれを省略すると、新しいジョブが作成されます。それ以外の場合は、関連するジョブ番号が編集されます。したがって、ジョブ番号52の会社名を編集するには、投稿データは次のようになります。

{
"job" : 52,
"name" : "New Name",
"token" : "dqwejk5GVT65909bHHBN7922pq5hxjm=-7hmn"
}

API エンドポイント

多くの API エンドポイントが API ドキュメントに記載されています。タスクのエンドポイントを確立するには、HireHopアプリケーションで、ブラウザーコンソールを使用して、ネットワーク呼び出しと設定されているパラメーターを検査します。 URLエンドポイントの広範なガイドがまもなく公開されます。

レート制限

HireHop では、各ユーザーが 1 分間に 60 回の接続要求を許可します。 60 を超える場合は、「セキュリティ警告、トランザクションが多すぎます」(327) エラーが返されます。

Posted in API