實作 C2C 連接器界面操作

的受管整合 AWS IoT Device Management 定義了 AWS Lambda 您必須處理的四個操作，才能符合連接器的資格。您的 C2C 連接器必須實作下列每個操作：

調用詳細資訊

的受管整合 AWS IoT Device Management 一律會透過 AWS Lambda invokeFunction動作，使用 JSON 字串承載叫用 Lambda 函數。請求操作必須在每個請求承載中包含 operationName 欄位。

調用設定：

實作範例

您為連接器實作的 Lambda 會從operationName請求承載剖析 ，並實作對應至第三方雲端的對應功能：

public ConnectorResponse handleRequest(final ConnectorRequest request) 
        throws OperationFailedException {
    Operation operation;
    try {
        operation = Operation.valueOf(request.payload().operationName());
    } catch (IllegalArgumentException ex) {
        throw new ValidationException(
           "Unknown operation '%s'".formatted(request.payload().operationName()), 
           ex
        );
    }

    return switch (operation) {
        case ActivateUser -> activateUserManager.activateUser(request);
        case DiscoverDevices -> deviceDiscoveryManager.listDevices(request);
        case SendCommand -> sendCommandManager.sendCommand(request);
        case DeactivateUser -> deactivateUser.deactivateUser(request);
    };
}

請求格式範例

下列範例詳細說明來自 受管整合的一般連接器請求，其中每個必要界面的常見欄位都存在。從範例中，您可以看到同時有一個請求標頭和請求承載。請求標頭在每個操作界面中都是常見的。

OAuth 2.0 範例：

{
        "header": {
                "auth": { 
                        "token": "ashriu32yr97feqy7afsaf", 
                        "type": "OAuth2.0"
                }
        },
        "payload":{
                "operationName": "AWS.SendCommand",
                "operationVersion": "1.0",
                "connectorId": "exampleId",
        …
        }
}

一般授權範例：

{
        "header": {
                "auth": { 
                        "secretsManager": {
                                "arn": "string",
                                "versionId": "string"
                        },
                        "type": "GeneralAuthorization"
                }
        },
        "payload":{
                "operationName": "AWS.SendCommand",
                "operationVersion": "1.0",
                "connectorId": "exampleId",
        …
        }
}

預設請求標頭

預設標頭欄位會根據授權類型而有所不同。連接器必須同時處理 OAuth 2.0 和一般授權請求標頭。

OAuth 2.0 預設標頭：

{
    "header": {
        "auth": {
            "token": string,    // End user's Access Token
            "type": "OAuth2.0"
        }
    }
}

一般授權預設標頭：

{
    "header": {
        "auth": {
            "secretsManager": {
                "arn": "string",
                "versionId": "string"
            },
            "type": "GeneralAuthorization"
        }
    }
}

請求承載

除了常見的標頭，每個請求都會有承載。雖然此承載的每個操作類型都有唯一的欄位，但每個承載都有一組永遠存在的預設欄位。

預設回應標頭

每個操作都會使用 回應 AWS IoT Device Management 的ACK受管整合，以確認您的 C2C 連接器已收到請求並開始處理。

{
 	"header":{
 		"responseCode": 200 
 	},
 	"payload":{
 		"responseMessage": “Example response!”
 	}
}

{
    "header": {
        "responseCode": Integer
    }
}

回應標頭欄位

在本文件所述的各種連接器界面和 API 結構描述中，都有 responseMessage或 Message 欄位。這是選用欄位，用於 C2C 連接器 Lambda 回應有關請求及其執行的任何內容。最好是，導致 狀態碼 以外的任何錯誤200都應該包含描述錯誤的訊息值。

使用 SendConnectorEvent API 回應 C2C 連接器操作請求

的受管整合 AWS IoT Device Management 預期您的連接器會針對每個 AWS.SendCommand和 AWS.DiscoverDevices操作以非同步方式運作。這表示對這些操作的初始回應只是「認可」您的 C2C 連接器已收到請求。

使用 SendConnectorEvent API，預期您的連接器會從以下清單中傳送 AWS.DiscoverDevices和 AWS.SendCommand操作的事件類型，以及主動裝置事件 （例如手動開啟和關閉的光源）。

範例工作流程

如果您的 C2C 連接器收到DiscoverDevices請求， 的受管整合 AWS IoT Device Management 預期會：

您可以在可存取 C2C 連接器 Lambda AWS 帳戶 登入資料的任何位置進行 SendConnectorEvent API 呼叫。在 AWS IoT Device Management 的受管整合收到此事件之前，裝置探索流程不會成功。

SendConnectorEvent API

連接器會呼叫 AWS IoT Device Management API 的受管整合來傳送裝置事件。只接受 3 種類型的事件：