ジンジャーAPIの概要や操作方法についてご案内します。
APIとは
APIとは、「アプリケーション・プログラミング・インターフェース(Application Programming Interface)」の略称で、システムやソフトウェア間をつなぐインターフェース(接点)のことを指します。
APIを利用して異なるシステムやソフトウェア間で情報を連携すると、互いの機能の一部を共有することができるようになります。
ジンジャーAPIについて
ジンジャーAPIでは、ジンジャーデータベース上の情報をAPIを通じて取得/登録/更新/削除できます。
取得した情報は従業員情報や、役職などのマスタを対象とし、ジンジャー内で登録したデータを外部のシステムやソフトウェアを利用する際に活用できます。
連携した外部のシステムなどを利用する際に、たとえば定期的にジンジャーデータベースの情報を取得・連携することで、従業員情報をジンジャーデータベースと同期できます。
また、外部のシステムやソフトウェアの従業員情報をジンジャーAPIに送り、ジンジャーデータベースに同期させることもできます。
ジンジャーAPIについての操作や、連携できる項目についてなどの詳細は、下記のリンクより確認してください。
操作可能な権限
以下のいずれかが付与された従業員のみ操作できます。
・マスタアカウント(契約初期に発行されたアカウント)
・システム管理者権限
操作方法
1.ジンジャーデータベースにて、[外部サービス連携]をクリックします。
2.ジンジャーAPIにて、ログインパスワードを入力し[送信]をクリックします。
パスワードを送信した後にジンジャーAPIの操作画面が表示されます。
3.APIキーまたはAPIシークレットキーが表示されます。
コピーボタンをクリックすると、APIキー/APIシークレットキーをコピーできます。
外部のシステムなどとAPI連携をする際に使用してください。
ポン ・一時閲覧ボタンをクリックすると、キーが表示されます。
・[更新]をクリックすると、キーを変更することが可能です。
・[更新]をクリックすると、キーを変更することが可能です。