On September 4, 2024, we announced the deprecation of the Instagram Basic Display API.

Starting December 4, 2024, all requests to the Instagram Basic Display API will return an error message. We recommend that you migrate your app to the Instagram API to avoid any disruption to your services.

Visit our News for Developers blog post to learn more.

概覽

Instagram 基本顯示 API 是一款採用 HTTP 的 API,可讓應用程式獲取 Instagram 用戶的個人檔案、圖片、影片和相簿。

由 2023 年 10 月 27 日起,如果您的應用程式需要獲取基本顯示 API 的進階存取權限,您可能需要完成資料處理問題。請參閱此網誌文章常見問題以了解詳情。

由 9 月 5 日起,部分開發人員可能需要在年度數據使用情形檢查期間回答資料處理問題。

不公開 Instagram 帳戶的長期存取憑證現在可以重新整理。另外,擁有不公開帳戶的應用程式用戶向應用程式所授予的權限有效期現為 90 日。

元件

基本網址

版本

此 API 支援與 Facebook Graph API 相同的版本控制協定和發佈週期。新版本大約每 3 個月發佈一次,每個版本將生效約 2 年,然後才會停用。

如要查詢指定 API 版本,請在查詢路徑中於基本網址後加入版本編號。例如:

https://graph.instagram.com/v11.0/10218560180051171/media

如果您在要求中省略了版本編號,則相關要求會解析成應用程式管理中心 > 設定 > 進階 > 升級 API 版本部分中指定的版本。

授權視窗

授權視窗可讓您的應用程式從應用程式用戶身上獲取授權碼權限。授權碼可用於換取 Instagram 用戶存取憑證,而您在查詢應用程式用戶的個人檔案或媒體時必須提供此憑證。

如要執行授權視窗,請參閱我們的獲取存取憑證指南。

授權碼

授權碼可用於換取短期 Instagram 用戶存取憑證。如要獲取授權碼,請在應用程式中執行授權視窗。應用程式用戶透過視窗驗證其身分並向應用程式授予任何所需權限後,我們會將用戶重新導向您的應用程式並附上授權碼。然後,您可以使用 API 來將代碼換為應用程式用戶的短期 Instagram 用戶存取憑證

授權碼是短期憑證,有效時間僅為 1 小時

Instagram 用戶存取憑證

API 的驗證是交由符合 OAuth 2.0 通訊協定的 Instagram 用戶存取憑證處理。存取憑證為應用程式範圍憑證,每位用戶在應用程式的相應憑證都不會重複,而且可以是短期或長期憑證。查詢 Instagram 用戶或其媒體的 API 要求必須包含 Instagram 用戶存取憑證。

短期存取權限

短期存取權限有效期為 1 小時,但是可以用於換取長期憑證。如要獲取短期存取憑證,請在應用程式中執行授權視窗。應用程式用戶透過視窗驗證其身分後,我們會將用戶重新導向以回到您的應用程式並附上授權碼,讓您接下來用以換取短期存取憑證。

長期存取憑證

尚未過期的短期憑證能夠換為長期存取憑證,後者的有效期為 60 日。您可以透過查詢 GET /refresh_access_token 端點,以在長期憑證失效前重新整理憑證。

權限

您的應用程式用戶可使用下列權限,以控制資料存取權限的授權。用戶必須先透過授權視窗向您的應用程式授予這些權限,應用程式方可存取其資料。

Instagram 測試人員可以隨時向您的應用程式授予這些權限。為了讓應用程式上沒有角色的用戶能夠向您的應用程式授予這些權限,您必須先透過應用程式審查程序就每項權限獲批進階存取權限,而您的應用程式也必須處於上線模式

由使用公開帳戶的應用程式用戶所授予的權限有效期為 90 日。如果授予憑證的應用程式用戶擁有公開帳戶,重新整理此應用程式用戶的長效存取憑證會延長權限授權多 90 日。如果應用程式用戶的帳戶為不公開,則權限授權無法延長,應用程式用戶在權限過期後必須再次向您的應用程式授權。

Instagram 測試人員

如要透過 Instagram 用戶測試您的應用程式,您必須先向有關 Instagram 用戶的帳戶傳送邀請,並請其接受邀請。您可前往應用程式管理中心 > 角色 > 角色分頁,於 Instagram 測試人員部分傳送邀請。

Instagram 用戶可在 Instagram 網站或流動應用程式上登入其帳戶,然後前往(個人檔案圖示) > 編輯個人檔案 > 應用程式和網站 > 測試員邀請部分,在此接受有關邀請。

資源

API 中的資料包含 Instagram 用戶及其媒體,即圖片、影片及相簿。所有資料均受到權限保護;您的應用程式如要存取用戶資料,必須由用戶透過授權視窗向您的應用程式授予資料存取權限。

用戶

Instagram 用戶及其個人檔案將由用戶節點代表。請注意,Instagram 舊版 API 用戶編號與 Instagram 基本顯示 API 不相容。

媒體

相片、影片和相簿將由媒體節點代表,系統會為各用戶分別建立此節點。

限速限制

所有端點要求都必須遵守 Graph API 的平台限速規定

您將 Instagram 產品加入自己的應用程式後,便可前往應用程式管理中心 > Instagram > 基本顯示限速分頁,以查看應用程式目前的呼叫使用次數。

應用程式類型

不支援經指定為商業應用程式的應用程式。如果您的應用程式為商業應用程式,請改用 Instagram Graph API,或者建立新的非商業應用程式。

應用程式審查

Instagram 測試人員可以隨時向您的應用程式授予 Instagram 權限。為了讓應用程式上沒有角色的用戶能夠向您的應用程式授予 Instagram 權限,您必須先透過應用程式審查程序就每項權限獲批進階存取權限,而您的應用程式也必須處於上線模式

當您完成應用程式開發工作,並準備好將應用程式切換至上線模式時,請查看有關應用程式審查、提交資料範例常見被拒原因的文件,以了解應用程式審查程序。在您熟習此程序後,便可以前往應用程式管理中心 > 產品 > Instagram > 基本顯示分頁,在此要求我們批准 Instagram 基本顯示 API 權限。

如果您建立應用程式只是為了透過用戶憑證產生工具產生存取憑證,則無需提交您的應用程式以接受應用程式審查。用戶憑證產生工具不需要用到任何權限,而且可以在您的應用程式處於開發模式時使用。

商家驗證

您的應用程式處於開發模式時,只能存取 Instagram 測試人員帳戶中的資料。您必須先完成商家驗證,才能將您的應用程式切換到上線模式以及存取非測試人員帳戶中的資料。

運作方式

如要使用此 API,您需要先設定授權視窗,並向應用程式用戶顯示此視窗。應用程式用戶會透過此視窗驗證其身分,然後向您的應用程式授予特定權限,來授權應用程式存取他們的資料。通過驗證後,視窗會將用戶重新導向以回到您的應用程式並附上授權碼。請擷取此代碼,並用來換取短期 Instagram 用戶存取憑證。獲得短期憑證後,您可以將之用於向用戶媒體端點查詢用戶已允許您應用程式存取的資料,或用來換取長期憑證

工具

用戶憑證產生工具

Instagram 用戶憑證產生工具可讓您快速產生長期 Instagram 用戶存取憑證,以供您的任何公開 Instagram 帳戶使用。如果您正在測試您的應用程式,但又不想費心執行授權視窗,或者如果您是在使用由第三方服務提供而可複製及貼上的程式碼,例如用以在自己網站中顯示您的 Instagram 資料,用戶憑證產生工具在這類情況下便相當實用。

此工具透過觸發授權視窗來運作,而您可以使用已指定為測試人員帳戶的公開 Instagram 帳戶在此視窗登入。登入後,工具便會產生長期存取憑證,以供您複製及貼上。請注意,您只可為公開 Instagram 帳戶產生此類憑證。

憑證具有可攜式特性!換言之,任何擁有您憑證的人士都可以使用我們的 API,從用於產生該憑證的 Instagram 測試人員帳戶中提取資料。因此,您只應與信任的第三方服務分享憑證。我們不鼓勵使用要求您提供憑證的第三方服務,有關服務反而應為您提供可複製及貼上的程式碼,並在當中加入憑證預留位置,方便您手動替換憑證。

您可前往應用程式管理中心 > 產品 > Instagram > 基本顯示分頁,在此使用憑證產生工具。

如果您建立應用程式只是為了透過用戶憑證產生工具產生存取憑證,則無需提交您的應用程式以接受應用程式審查。用戶憑證產生工具不需要用到任何權限,而且可以在您的應用程式處於開發模式時使用。

後續步驟

請參考我們的入門指南,了解如何設定應用程式和執行基本 API 要求。