アクティモのREST APIを使用して、ソースシステムからアクティモに従業員をプロビジョニングできます。 これにより、Actimoで従業員を作成、更新、削除するという3つの中核的な仕事を処理できるようになります。

APIコールの制限/要求：

APIキー1つにつき、1秒間に20回のAPIリクエスト/コールの制限があります。

API Doc: https://app.swaggerhub.com/apis-docs/Actimo/Actimo

APIキー：お客様のプラットフォームの管理者に、インテグレーションスペシャリストに連絡してください。

ジャンプするマネージャーと従業員の関係を構築する

APIを理解する

• アクティモの従業員はコンタクトと呼ばれます。 これらはそれぞれ独自のID（id）を取得し、それを使って更新や変更を行うことができる。

• すべてのAPIコールは、developタブを通じてUIで見ることができます。 オーナーからプラットフォームへの管理者ログインを取得すれば、UIでアクションを実行することで、コールとペイロードをコピー/ペーストできる。

• アクティモにはサンドボックス環境がない。 テスト用プラットフォームが必要な場合は、カスタマー・サクセス・マネージャーにご相談ください。

• アクティモのAPIはJSON形式です。

• アクティモには、"姓 "や "名 "といったデフォルトのフィールドが用意されています。 次に、必要に応じてカスタムフィールドを作成することも可能である。 デフォルト・フィールドが、そのフィールドが持つデータの後に論理名を持つのに対し、カスタム・フィールドはdata1、data2などと呼ばれることに留意してください。 これらの名前は、UIの開発者タブで確認できる。

コンタクトの作成

アクティモでコンタクトを作成するには、以下の呼び出しが必要です。

POST：https://a.actimo.com/api/v1/contacts

コンタクトに追加したい必要なデータをペイロードとしてボディに追加する。

連絡先の削除

アクティモで連絡先を削除するには、以下の呼び出しが必要です。

DEL:https://a.actimo.com/api/v1/contacts?forceAnonymize=false&ids=8562180&ids=8562181&ids=8562182

この例では、太字で強調表示されたパラメータでマークされた3つのコンタクトを一度に削除します。

連絡先の更新

アクティモで連絡先を更新するには、以下の呼び出しが必要です。

PUT:https://a.actimo.com/api/v1/contacts/"contact id"

ボディにペイロードを追加し、コンタクトの更新に必要なデータを追加する。

アドオンマネージャーと従業員の関係を作る

マネジャーと従業員のコンタクトの間にリレーションシップを作成したい場合は、以下の呼び出しが必要です。 マネージャーと従業員の両方の連絡先IDを使用する必要があることに留意してください。

PUT:https://a.actimo.com/api/v1/contacts/8562183/relationships

質問は？

APIに関するご質問は、弊社のインテグレーションスペシャリストまでお寄せください。 アクティモに入社される場合、すでにスペシャリストと直接コンタクトが取れるようになっています。

また、お役に立ったかどうか、下の絵文字をクリックするか、support@actimo.com。