建立自訂 API 時，您必須使用解決方案。 如果您不熟悉解決方案，請先閱讀建立 解決方案。
您的解決方案必須與發行者相關聯。 發行者具有與其相關聯的特定自訂前置詞。 建立自訂 API 時，您必須使用自訂前置詞，而且此前置詞應該與解決方案發行者所使用的相同。 下列指示會使用該值 sample 作為自訂前置詞，因為它是為發行者設定的值。
這很重要
- 現在有更好的體驗來建立自訂 API。 您可以在外掛程式註冊工具中使用設計器。 其他資訊： 使用外掛程式註冊工具建立自訂 API
- 許多與建立自訂 API 相關的欄位在建立後無法變更。 在開始之前，您應該仔細規劃自訂 API 的設計。 如果您稍後決定在建立自訂 API 之後需要變更內容，您可能需要刪除現有記錄並重新建立自訂 API。 查看在此無法更改的欄位資訊：CustomAPI 資料表
建立自訂 API 記錄
在您的解決方案中，從下拉式清單中選取新增>更多>其他>自訂 API。
編輯欄位以設定自訂 API 的屬性。 您必須設定下列欄位的值。 如需詳細資訊，請參閱 自訂 API 表格欄
在建立外掛程式之前，您無法設定「 外掛程式類型」 的值。 您稍後可以變更它。
選取 [儲存]。 您的表單應該如下所示
建立任何要求參數
自訂 API 不需要參數。 建立所需數量的參數，以傳遞邏輯所需的資料。
在您的解決方案中，從下拉式清單中選取 [新增>更多>其他>自訂 API 要求參數 ]。
編輯欄位以設定自訂 API 請求參數的屬性。 如需詳細資訊，請參閱 CustomAPIRequestParameter 資料表資料行
選取 [儲存]。 您的表單應該如下所示：
建立任何回應屬性
代表動作的自訂 API 不需要回應屬性。 函數必須至少有一個。 如果作業成功，則會傳回成功回應。 如果失敗，則會傳回錯誤。 您應該為 API 傳回的任何資料定義回應屬性。
如果只定義單一 Entity 或 EntityCollection 回應屬性，則回應屬於該類型。 如果有多個內容，或一或多個簡單類型的內容，API 會傳回複雜類型，其中每一個回應內容都是該複雜類型的內容。
例如，如果您的自訂 API 唯一名稱為 sample_CustomAPIExample，則會傳回名為的 sample_CustomAPIExampleResponse 複雜類型，其中包含您定義的每個回應屬性的屬性。
在您的解決方案中，從下拉式清單中選取 [新增>更多>其他>自訂 API 回應屬性 ]。
編輯欄位以設定自訂 API 回應屬性的屬性。 如需詳細資訊，請參閱 CustomAPIResponseProperty 資料表資料行
選取 [儲存]。 您的表單應該如下所示：
查看服務文件中的結果
如果您尚未設定IsPrivate自訂 API 的屬性，您現在可以使用GET要求從CSDL $metadata 文件擷取服務定義，甚至可以透過瀏覽器擷取。 如果您環境的URL為 https://yourorg.crm.dynamics.com，您可以在瀏覽器位址欄位中輸入此URL，以擷取$metadata： https://yourorg.crm.dynamics.com/api/data/v9.1/$metadata。
在結果中搜尋自訂 API 的名稱。 例如，使用上述步驟定義的 API 如下所示：
<ComplexType Name="sample_CustomAPIExampleResponse">
<Property Name="StringProperty" Type="Edm.String" Unicode="false" />
</ComplexType>
<Action Name="sample_CustomAPIExample">
<Parameter Name="StringParameter" Type="Edm.String" Nullable="false" Unicode="false" />
<ReturnType Type="mscrm.sample_CustomAPIExampleResponse" Nullable="false" />
</Action>
測試您的自訂 API
建立自訂 API 之後，您可以嘗試一下。 即使您尚未設定外掛程式類型來定義主要作業，您現在也可以測試它，以驗證您可以正確呼叫它。 任何回應屬性都會傳回其預設值，例如 null。 其他資訊： 叫用自訂 API。
更新自訂 API 外掛程式類型
如需如何撰寫自訂 API 外掛程式的相關資訊，請參閱 撰寫自訂 API 的外掛程式。
註冊組件後，您需要為您建立的自訂 API 設定 Plug-in 類型值。 這是一個查閱屬性，因此您只需找到註冊組件時所建立的 Plug-in 類型。
設定 外掛程式型別後，您可以測試自訂 API 以驗證傳回正確的結果。
建立自訂 API 的其他方式
外掛程式註冊工具提供自訂 API 設計工具。 其他資訊： 使用外掛程式註冊工具建立自訂 API
您可能需要建立允許在設計工具外部建立自訂 API 的用戶端應用程式。 由於自訂 API 的資料儲存在資料表中，因此您可以使用程式碼來建立它們。 其他資訊： 使用程式碼建立自訂 API。
為您的 ALM 流程提供更佳服務的方法，可能是透過編輯解決方案檔案來建立自訂 API。 其他資訊： 使用解決方案檔案建立自訂 API。
另請參閱
建立與使用自訂 API
使用外掛程式註冊工具建立自訂 API
使用程式碼建立自訂 API
使用解決方案檔案建立自訂 API
建立您自己的訊息