API

エンドポイントは 2 つ、読み取り専用です。パイプラインがそのワークスペースについて見つけた内容、つまり読み取った企業と、すべての段階を通過した企業を返します。ダッシュボードのその 2 画面が表示している情報はすべてここから JSON で取得でき、対象は同じワークスペースに限られます。

認証

ダッシュボードの 設定 でキーを作成してください。保存されるのはハッシュのみのため、表示は一度きりで、あとから再表示できる画面はありません。ベアラートークンとして送信してください。

curl https://knockwire.com/api/reads \
  -H "Authorization: Bearer kw_live_..."

キーがない、ヘッダーの形式が不正、またはキーが失効している場合は 401 を返し、そのどれに当たるかを JSON の本文で示します。キーはそのワークスペースのすべての企業とすべての却下を読み取れるため、パスワードと同じ扱いが必要です。設定でキーを失効させると、次のリクエストから有効になります。

エンドポイント

• GET /api/reads パイプラインが確認したすべての企業を、新しい順に返します。outcome=refuse または outcome=knock で絞り込めます。既定は却下です。読む価値があるのは却下のほうだからです。limit の既定値は 100、上限は 500 に丸められます。
• GET /api/prospects 4 つの段階をすべて通過した企業を、スコアとその根拠とともに返します。

ワークスペースを指定するパラメータはありません。どのデータが返るかを決めるのはキーであり、tenant= を含むリクエストは黙って無視するのではなく 400 で拒否します。

この API がまだできないこと

統合作業の途中で気づくことがないよう、ここに書いておきます。

• 書き込みはできません。 企業のリストを受け取るエンドポイントはありません。探索は自身のソースを読みます。
• 送信はできません。 この API からメッセージを承認することも送信することもできません。承認はダッシュボードにいる人間が行います。これは機能の不足ではなく、製品としての判断です。
• バージョンの接頭辞はありません。 形が動いている間、パスにバージョンは付けません。変更する際は 変更履歴 で告知します。
• 公開されたレート制限はありません。 現時点でキーごとの制限はありません。常識的な範囲でご利用ください。制限は必要になってからではなく、必要になる前に導入する予定です。