Teachworks APIは、Teachworksアカウント内のデータにアクセスして、カスタム統合やソフトウェアを開発できるようにするアプリケーションプログラミングインターフェースです。
注: APIへのアクセスは、「Growth」および「Premium」プランをご利用の企業のみが利用可能です。
APIを有効にする
「アカウント」をクリックし、次に「統合とアドオン」をクリックしてください。
上部の「検索」フィールドに「API」と入力してください。
APIを有効にするには、トグルスイッチを「オン」に切り替えてください。
使用法
APIを有効にした後、「設定」リンクをクリックしてください。「APIトークンを生成」ボタンをクリックすると、Teachworks APIトークンを生成できます。
このキーは、API経由でアカウントにアクセスするために使用します。このキーはパスワードのように厳重に保護し、公開ウェブページには含めないでください(公開ウェブページの場合は、サーバー側で使用してください)。
API統合を会社の本番アカウントに接続する前にテストするためのサンドボックスアカウントを作成したい場合は、「サンドボックスアカウントを作成」ボタンをクリックすることもできます。
APIドキュメント
Teachworks APIのドキュメントはこちらをご覧ください:Teachworks APIドキュメント。今後、より多くの種類のデータにアクセスしたり、レコードを管理したりするためのエンドポイントをAPIに追加していく予定です。
現在利用できないエンドポイントにご興味がある場合は、 support@teachworks.comまでご連絡ください。追加を検討させていただきます。