適用対象
- 社内アプリ:企業が自社で開発し、自社内のみで使用するアプリです。組織内部のシステム統合シーンに適しています。
- サードパーティ社内アプリ:ISV(独立系ソフトウェアベンダー)が開発し、複数の企業顧客がインストールして利用するサービス型アプリです。
- サードパーティ個人アプリ:プロダクトソリューションプロバイダーの開発者が開発し、DingTalk 上の個人ユーザーに提供するアプリです。
機能概要
DingTalk のサーバー API を呼び出す前に、必ずアプリに対応する API 呼び出し権限を追加する必要があります。アプリ作成後、システムはデフォルトで一部のベーシック権限を付与します。業務ニーズに応じて必要な API 権限を適切に申請し、DingTalk のコア機能との深い統合を実現することを推奨します。 API 権限はアプリ単位で付与され、各アプリ間で権限は相互に独立しています。同一企業の複数のアプリが同じ API を呼び出す必要がある場合でも、各アプリで個別に申請する必要があります。 例:社内に A、B 2 つのアプリが存在し、アプリ A がすでに連絡先の読み取り権限を保有していても、アプリ B が連絡先データにアクセスするには、別途「連絡先」関連の権限を申請する必要があります。操作手順はアプリ A と同様です。前提条件
API 権限を設定する前に、以下の条件を満たしていることを確認してください。- アプリタイプが社内アプリ、サードパーティ社内アプリまたはサードパーティ個人アプリであり、開発者バックエンドで作成済みであること。
- 現在ログイン中のアカウントが、該当アプリの管理権限(通常は組織管理者またはアプリ責任者)を保有していること。
- 企業の認証が完了していること(一部の特殊な API は企業の実名認証完了後にのみ申請可能です)。
- API 呼び出しの認証に使用するアプリの
AppKeyとAppSecretを取得し、適切に設定していること。
一般的な API 呼び出し権限の追加
公開されているほとんどのサーバー API に適用され、開発者バックエンドで直接セルフ申請できます。 操作手順:- API ドキュメントで、対象 API ドキュメントの権限セクションにある権限スコープをコピーします。
- 開発者バックエンドにログインします。
- アプリ開発ページで、対象アプリをクリックしてアプリ詳細ページに移動します。
- アプリ詳細ページで権限管理をクリックし、コピーした権限スコープを検索して権限をリクエストをクリックします。
特殊な API 呼び出し権限の追加
非公開のセンシティブな API や業界専用の API については、DingTalk 側の人手による審査を経てから有効化できます。 操作手順:- API ドキュメントで、対象 API ドキュメントの権限セクションにある権限スコープをコピーします。
- 管理者が開発者バックエンドにログインします。
- アプリ開発ページで、対象アプリをクリックしてアプリ詳細ページに移動します。
- 権限管理をクリックし、追加したい特殊な API を選択して権限をリクエストをクリックします。
-
申請理由を入力し、最後に申請をクリックします。
説明
- API 呼び出し権限の申請は、対応する API の DingTalk 担当者が承認します。承認は通常 1 営業日以内に完了し、承認後はステータスが有効化完了に変わります。
- 申請が拒否された場合、申請欄で該当の権限エントリを確認し、審査未通過タグにマウスを合わせると具体的な却下理由が表示されます。フィードバックに基づき改善のうえ、再度送信してください。
権限不足エラーの解決方法
この解決方法は現時点では新版サーバー API を呼び出す場合のみ適用されます。
403 エラーが返された場合、レスポンスボディに詳細な権限不足情報が含まれます。
- エラーレスポンス内の
AccessDeniedDetailにあるrequiredScopesフィールドの値を抽出します。これが対象 API に必要な権限スコープ Code です。 - 現在のアプリの権限管理ページで、その権限スコープ Code を検索し、対応する API 権限の有効化を申請します。