Integratie van Azure Block Chain Workbench-berichten

Naast het leveren van een REST API biedt Azure Block Chain Workbench ook integratie op basis van berichten. Workbench publiceert grootboek gerichte gebeurtenissen via Azure Event Grid, waardoor downstream-gebruikers gegevens opnemen of actie ondernemen op basis van deze gebeurtenissen. Voor die clients die betrouw bare berichten vereisen, levert Azure Block Chain Workbench ook berichten aan een Azure Service Bus eind punt.

Invoer-Api's

Als u trans acties van externe systemen wilt initiëren om gebruikers te maken, contracten te maken en contracten bij te werken, kunt u invoer-Api's voor berichten gebruiken om trans acties op een groot boek uit te voeren. Zie voor beelden van berichten integratie voor een voor beeld van invoer-api's.

Hieronder vindt u de momenteel beschik bare invoer-Api's.

Gebruiker maken

Hiermee maakt u een nieuwe gebruiker.

De aanvraag vereist de volgende velden:

Voorbeeld:

{
    "requestId": "e2264523-6147-41fc-bbbb-edba8e44562d",
    "firstName": "Ali",
    "lastName": "Alio",
    "emailAddress": "aa@contoso.com",
    "externalId": "6a9b7f65-ffff-442f-b3b8-58a35abd1bcd",
    "connectionId": 1,
    "messageSchemaVersion": "1.0.0",
    "messageName": "CreateUserRequest"
}

Block Chain Workbench retourneert een antwoord met de volgende velden:

Voor beeld van succes volle gebruikers reactie van Block Chain Workbench:

{ 
    "requestId": "e2264523-6147-41fc-bb59-edba8e44562d", 
    "userId": 15, 
    "userChainIdentifier": "0x9a8DDaCa9B7488683A4d62d0817E965E8f248398", 
    "connectionId": 1, 
    "messageSchemaVersion": "1.0.0", 
    "messageName": "CreateUserUpdate", 
    "status": "Success", 
    "additionalInformation": { } 
} 

Als de aanvraag is mislukt, vindt u meer informatie over de fout.

{
    "requestId": "e2264523-6147-41fc-bb59-edba8e44562d", 
    "userId": 15, 
    "userChainIdentifier": null, 
    "connectionId": 1, 
    "messageSchemaVersion": "1.0.0", 
    "messageName": "CreateUserUpdate", 
    "status": "Failure", 
    "additionalInformation": { 
        "errorCode": 4000, 
        "errorMessage": "User cannot be provisioned on connection." 
    }
}

Contract maken

Hiermee maakt u een nieuw contract.

De aanvraag vereist de volgende velden:

Voorbeeld:

{ 
    "requestId": "ce3c429b-a091-4baa-b29b-5b576162b211", 
    "userChainIdentifier": "0x9a8DDaCa9B7488683A4d62d0817E965E8f248398", 
    "applicationName": "AssetTransfer",
    "version": "1.0",
    "workflowName": "AssetTransfer", 
    "parameters": [ 
        { 
            "name": "description", 
            "value": "a 1969 dodge charger" 
        }, 
        { 
            "name": "price", 
            "value": "12345" 
        } 
    ], 
    "connectionId": 1, 
    "messageSchemaVersion": "1.0.0", 
    "messageName": "CreateContractRequest" 
}

Block Chain Workbench retourneert een antwoord met de volgende velden:

Voor beeld van een ingediend verzoek om een contract te maken vanuit Block Chain Workbench:

{
    "requestId": "ce3c429b-a091-4baa-b29b-5b576162b211",
    "contractId": 55,
    "contractLedgerIdentifier": "0xde0B295669a9FD93d5F28D9Ec85E40f4cb697BAe",
    "connectionId": 1,
    "messageSchemaVersion": "1.0.0",
    "messageName": "CreateContractUpdate",
    "status": "Submitted",
    "additionalInformation": { }
}

Voor beeld van een vastgelegd antwoord op een contract voor het maken van Block Chain-Workbench:

{
    "requestId": "ce3c429b-a091-4baa-b29b-5b576162b211",
    "contractId": 55,
    "contractLedgerIdentifier": "0xde0B295669a9FD93d5F28D9Ec85E40f4cb697BAe",
    "connectionId": 1,
    "messageSchemaVersion": "1.0.0",
    "messageName": "CreateContractUpdate",
    "status": "Committed",
    "additionalInformation": { }
}

Als de aanvraag is mislukt, vindt u meer informatie over de fout.

{
    "requestId": "ce3c429b-a091-4baa-b29b-5b576162b211",
    "contractId": 55,
    "contractLedgerIdentifier": null,
    "connectionId": 1,
    "messageSchemaVersion": "1.0.0",
    "messageName": "CreateContractUpdate",
    "status": "Failure",
    "additionalInformation": {
        "errorCode": 4000,
        "errorMessage": "Contract cannot be provisioned on connection."
    }
}

Contract actie maken

Hiermee maakt u een nieuwe contract actie.

De aanvraag vereist de volgende velden:

Voorbeeld:

{
    "requestId": "a5530932-9d6b-4eed-8623-441a647741d3",
    "userChainIdentifier": "0x9a8DDaCa9B7488683A4d62d0817E965E8f248398",
    "contractLedgerIdentifier": "0xde0B295669a9FD93d5F28D9Ec85E40f4cb697BAe",
    "version": "1.0",
    "workflowFunctionName": "modify",
    "parameters": [
        {
            "name": "description",
            "value": "a 1969 dodge charger"
        },
        {
            "name": "price",
            "value": "12345"
        }
    ],
    "connectionId": 1,
    "messageSchemaVersion": "1.0.0",
    "messageName": "CreateContractActionRequest"
}

Block Chain Workbench retourneert een antwoord met de volgende velden:

Voor beeld van een verzonden actie respons voor het maken van een contract vanuit Block Chain Workbench:

{
    "requestId": "a5530932-9d6b-4eed-8623-441a647741d3",
    "contractId": 105,
    "connectionId": 1,
    "messageSchemaVersion": "1.0.0",
    "messageName": "CreateContractActionUpdate",
    "status": "Submitted",
    "additionalInformation": { }
}

Voor beeld van een vastgelegd actie respons voor het maken van een contract vanuit Block Chain Workbench:

{
    "requestId": "a5530932-9d6b-4eed-8623-441a647741d3",
    "contractId": 105,
    "connectionId": 1,
    "messageSchemaVersion": "1.0.0",
    "messageName": "CreateContractActionUpdate",
    "status": "Committed",
    "additionalInformation": { }
}

Als de aanvraag is mislukt, vindt u meer informatie over de fout.

{
    "requestId": "a5530932-9d6b-4eed-8623-441a647741d3",
    "contractId": 105,
    "connectionId": 1,
    "messageSchemaVersion": "1.0.0",
    "messageName": "CreateContractActionUpdate",
    "status": "Failure",
    "additionalInformation": {
        "errorCode": 4000,
        "errorMessage": "Contract action cannot be provisioned on connection."
    }
}

Invoer-API-fout codes en-berichten

Fout code 4000: onjuiste aanvraag fout

• Ongeldige connectionId
• CreateUserRequest-deserialisatie is mislukt
• CreateContractRequest-deserialisatie is mislukt
• CreateContractActionRequest-deserialisatie is mislukt
• De toepassing {geïdentificeerd door de toepassings naam} bestaat niet
• De toepassing {geïdentificeerd door de toepassings naam} heeft geen werk stroom
• UserChainIdentifier bestaat niet
• Contract {geïdentificeerd door boekhoud-id} bestaat niet
• Contract {geïdentificeerd door boekhoud-id} heeft geen functie {naam werk stroom functie}
• UserChainIdentifier bestaat niet

Fout code 4090: conflict fout

• Gebruiker bestaat al
• Contract bestaat al
• De contract actie bestaat al

Fout code 5000: interne server fout

• Uitzonderings berichten

Gebeurtenismeldingen

Gebeurtenis meldingen kunnen worden gebruikt voor het melden van gebruikers en downstream-systemen van gebeurtenissen die plaatsvinden in Block Chain Workbench en het block chain-netwerk waarmee het is verbonden. Gebeurtenis meldingen kunnen rechtstreeks in code worden verbruikt of worden gebruikt met hulpprogram ma's als Logic Apps en flow om gegevens stroom naar downstream-systemen te activeren.

Zie Naslag informatie voor meldings berichten voor details over verschillende berichten die kunnen worden ontvangen.

Event Grid gebeurtenissen gebruiken met Azure Functions

Als een gebruiker Event Grid wil gebruiken om op de hoogte te worden gesteld van gebeurtenissen die zich in Block Chain Workbench voordoen, kunt u gebeurtenissen uit Event Grid gebruiken met behulp van Azure Functions.

1. Maak een Azure-functie-app in het Azure Portal.
2. Maak een nieuwe functie.
3. Zoek de sjabloon voor de Event Grid. De Basic-sjabloon code voor het lezen van het bericht wordt weer gegeven. Wijzig de code naar wens.
4. Sla de functie op.
5. Selecteer de Event Grid van de resource groep van Block Chain Workbench.

Event Grid gebeurtenissen gebruiken met Logic Apps

1. Maak een nieuwe Azure Logic-app in de Azure Portal.
2. Wanneer u de Azure Logic-app in de portal opent, wordt u gevraagd een trigger te selecteren. Selecteer Azure Event grid--als er een resource gebeurtenis optreedt.
3. Wanneer de werk stroom ontwerper wordt weer gegeven, wordt u gevraagd u aan te melden.
4. Selecteer het abonnement. Resource als micro soft. EventGrid. topics. Selecteer de resource naam uit de naam van de resource uit de resource groep Azure Block Chain Workbench.
5. Selecteer de Event Grid van de resource groep van Block Chain Workbench.

Service Bus onderwerpen gebruiken voor meldingen

Service Bus-onderwerpen kunnen worden gebruikt om gebruikers op de hoogte te stellen van gebeurtenissen die zich in Block Chain Workbench voordoen.

1. Blader naar de Service Bus in de resource groep van de Workbench.
2. Selecteer Onderwerpen.
3. Selecteer uitgangs-onderwerp.
4. Maak een nieuw abonnement op dit onderwerp. Schaf hiervoor een sleutel aan.
5. Een programma maken dat zich abonneert op gebeurtenissen van dit abonnement.

Service Bus berichten gebruiken met Logic Apps

1. Maak een nieuwe Azure Logic-app in de Azure Portal.
2. Wanneer u de Azure Logic-app in de portal opent, wordt u gevraagd een trigger te selecteren. Typ Service Bus in het zoekvak en selecteer de trigger die geschikt is voor het type interactie dat u wilt hebben met de service bus. Bijvoorbeeld Service Bus: wanneer een bericht wordt ontvangen in een onderwerps abonnement (automatisch volt ooien).
3. Wanneer de werk stroom ontwerper wordt weer gegeven, geeft u de verbindings gegevens voor de Service Bus op.
4. Selecteer uw abonnement en geef het onderwerp van Workbench-extern op.
5. Ontwikkel de logica voor uw toepassing die gebruikmaakt van het bericht van deze trigger.

Naslag informatie voor meldings berichten

De meldings berichten bevatten afhankelijk van de bericht naam een van de volgende bericht typen.

Bericht blok keren

Bevat informatie over afzonderlijke blokken. De BlockMessage bevat een sectie met informatie over het blok niveau en een sectie met transactie gegevens.

Gegevens blok keren

Trans actie-informatie

Voor beeld van een BlockMessage van Block Chain Workbench:

{
    "block": {
        "blockId": 123,
        "blockNumber": 1738312,
        "blockHash": "0x03a39411e25e25b47d0ec6433b73b488554a4a5f6b1a253e0ac8a200d13fffff",
        "previousBlockHash": null,
        "blockTimestamp": "2018-10-09T23:35:58Z",
    },
    "transactions": [
        {
            "transactionId": 234,
            "transactionHash": "0xa4d9c95b581f299e41b8cc193dd742ef5a1d3a4ddf97bd11b80d123fec27ffff",
            "from": "0xd85e7262dd96f3b8a48a8aaf3dcdda90f60dffff",
            "to": null,
            "provisioningStatus": 1
        },
        {
            "transactionId": 235,
            "transactionHash": "0x5c1fddea83bf19d719e52a935ec8620437a0a6bdaa00ecb7c3d852cf92e1ffff",
            "from": "0xadd97e1e595916e29ea94fda894941574000ffff",
            "to": "0x9a8DDaCa9B7488683A4d62d0817E965E8f24ffff",
            "provisioningStatus": 2
        }
    ],
    "connectionId": 1,
    "messageSchemaVersion": "1.0.0",
    "messageName": "BlockMessage",
    "additionalInformation": {}
}

Contract bericht

Bevat informatie over een contract. Het bericht bevat een sectie met contract eigenschappen en een sectie met transactie gegevens. Alle trans acties die het contract voor het desbetreffende blok hebben gewijzigd, worden opgenomen in de sectie trans actie.

Transactie gegevens wijzigen

Eigenschappen van contract

Voor beeld van een ContractMessage van Block Chain Workbench:

{
    "blockId": 123,
    "blockhash": "0x03a39411e25e25b47d0ec6433b73b488554a4a5f6b1a253e0ac8a200d13fffff",
    "modifyingTransactions": [
        {
            "transactionId": 234,
            "transactionHash": "0x5c1fddea83bf19d719e52a935ec8620437a0a6bdaa00ecb7c3d852cf92e1ffff",
            "from": "0xd85e7262dd96f3b8a48a8aaf3dcdda90f60dffff",
            "to": "0xf8559473b3c7197d59212b401f5a9f07ffff"
        },
        {
            "transactionId": 235,
            "transactionHash": "0xa4d9c95b581f299e41b8cc193dd742ef5a1d3a4ddf97bd11b80d123fec27ffff",
            "from": "0xd85e7262dd96f3b8a48a8aaf3dcdda90f60dffff",
            "to": "0xf8559473b3c7197d59212b401f5a9f07b429ffff"
        }
    ],
    "contractId": 111,
    "contractLedgerIdentifier": "0xf8559473b3c7197d59212b401f5a9f07b429ffff",
    "contractProperties": [
        {
            "workflowPropertyId": 1,
            "name": "State",
            "value": "0"
        },
        {
            "workflowPropertyId": 2,
            "name": "Description",
            "value": "1969 Dodge Charger"
        },
        {
            "workflowPropertyId": 3,
            "name": "AskingPrice",
            "value": "30000"
        },
        {
            "workflowPropertyId": 4,
            "name": "OfferPrice",
            "value": "0"
        },
        {
            "workflowPropertyId": 5,
            "name": "InstanceAppraiser",
            "value": "0x0000000000000000000000000000000000000000"
        },
        {
            "workflowPropertyId": 6,
            "name": "InstanceBuyer",
            "value": "0x0000000000000000000000000000000000000000"
        },
        {
            "workflowPropertyId": 7,
            "name": "InstanceInspector",
            "value": "0x0000000000000000000000000000000000000000"
        },
        {
            "workflowPropertyId": 8,
            "name": "InstanceOwner",
            "value": "0x9a8DDaCa9B7488683A4d62d0817E965E8f24ffff"
        },
        {
            "workflowPropertyId": 9,
            "name": "ClosingDayOptions",
            "value": "[21,48,69]"
        }
    ],
    "isNewContract": false,
    "connectionId": 1,
    "messageSchemaVersion": "1.0.0",
    "messageName": "ContractMessage",
    "additionalInformation": {}
}

Gebeurtenis bericht: aanroep van contract functie

Bevat informatie over het aanroepen van een contract functie, zoals de functie naam, de invoer van para meters en de aanroeper van de functie.

Gegevens van oproepende functie

Parametergegevens

Trans actie-informatie voor gebeurtenis bericht

Voor beeld van een EventMessage-ContractFunctionInvocation van Block Chain Workbench:

{
    "eventName": "ContractFunctionInvocation",
    "caller": {
        "type": "User",
        "id": 21,
        "ledgerIdentifier": "0xd85e7262dd96f3b8a48a8aaf3dcdda90f60ffff"
    },
    "contractId": 34,
    "contractLedgerIdentifier": "0xf8559473b3c7197d59212b401f5a9f07b429ffff",
    "functionName": "Modify",
    "parameters": [
        {
            "name": "description",
            "value": "a new description"
        },
        {
            "name": "price",
            "value": "4567"
        }
    ],
    "transaction": {
        "transactionId": 234,
        "transactionHash": "0x5c1fddea83bf19d719e52a935ec8620437a0a6bdaa00ecb7c3d852cf92e1ffff",
        "from": "0xd85e7262dd96f3b8a48a8aaf3dcdda90f60dffff",
        "to": "0xf8559473b3c7197d59212b401f5a9f07b429ffff"
    },
    "inTransactionSequenceNumber": 1,
    "connectionId": 1,
    "messageSchemaVersion": "1.0.0",
    "messageName": "EventMessage",
    "additionalInformation": { }
}

Gebeurtenis bericht: opname van toepassing

Bevat informatie over het uploaden van een toepassing naar Workbench, zoals de naam en de versie van de geüploade toepassing.

Informatie over contract code

Informatie over toepassingsrol

Informatie over de werk stroom van de toepassing

Informatie over werk stroom functies

Status informatie werk stroom

Informatie over werk stroom-eigenschappen

Voor beeld van een EventMessage-ApplicationIngestion van Block Chain Workbench:

{
    "eventName": "ApplicationIngestion",
    "applicationId": 31,
    "applicationName": "AssetTransfer",
    "applicationDisplayName": "Asset Transfer",
    "applicationVersion": "1.0",
    "applicationDefinitionLocation": "http://url",
    "contractCodes": [
        {
            "id": 23,
            "ledgerId": 1,
            "location": "http://url"
        }
    ],
    "applicationRoles": [
            {
                "id": 134,
                "name": "Buyer"
            },
            {
                "id": 135,
                "name": "Seller"
            }
       ],
    "applicationWorkflows": [
        {
            "id": 89,
            "name": "AssetTransfer",
            "displayName": "Asset Transfer",
            "functions": [
                {
                    "id": 912,
                    "name": "",
                    "parameters": [
                        {
                            "name": "description",
                            "type": {
                                "name": "string"
                             }
                        },
                        {
                            "name": "price",
                            "type": {
                                "name": "int"
                            }
                        }
                    ]
                },
                {
                    "id": 913,
                    "name": "modify",
                    "parameters": [
                        {
                            "name": "description",
                            "type": {
                                "name": "string"
                             }
                        },
                        {
                            "name": "price",
                            "type": {
                                "name": "int"
                            }
                        }
                    ]
                }
            ],
            "states": [ 
                 {
                      "name": "Created",
                      "displayName": "Created",
                      "style" : "Success"
                 },
                 {
                      "name": "Terminated",
                      "displayName": "Terminated",
                      "style" : "Failure"
                 }
            ],
            "properties": [
                {
                    "id": 879,
                    "name": "Description",
                    "type": {
                        "name": "string"
                     }
                },
                {
                    "id": 880,
                    "name": "Price",
                    "type": {
                        "name": "int"
                     }
                }
            ]
        }
    ],
    "connectionId": [ ],
    "messageSchemaVersion": "1.0.0",
    "messageName": "EventMessage",
    "additionalInformation":
        {
            "states" :
            [
                {
                    "Name": "BuyerAccepted",
                    "Transitions": [
                        {
                            "DisplayName": "Accept",
                            "AllowedRoles": [ ],
                            "AllowedInstanceRoles": [ "InstanceOwner" ],
                            "Function": "Accept",
                            "NextStates": [ "SellerAccepted" ]
                        }
                    ]
                }
            ]
        }
}

Gebeurtenis bericht: roltoewijzing

Bevat informatie wanneer aan een gebruiker een rol is toegewezen in Workbench, zoals wie de roltoewijzing en de naam van de rol en de bijbehorende toepassing heeft uitgevoerd.

Toepassingsrol RoleAssignment

RoleAssignment-Toewijzer

Toegewezen RoleAssignment

Voor beeld van een EventMessage-RoleAssignment van Block Chain Workbench:

{
    "eventName": "RoleAssignment",
    "applicationId": 31,
    "applicationName": "AssetTransfer",
    "applicationDisplayName": "Asset Transfer",
    "applicationVersion": "1.0",
    "applicationRole": {
        "id": 134,
        "name": "Buyer"
    },
    "assigner": {
        "id": 1,
        "type": null,
        "chainIdentifier": "0xeFFC7766d38aC862d79706c3C5CEEf089564ffff"
    },
    "assignee": {
        "id": 3,
        "type": null,
        "chainIdentifier": "0x9a8DDaCa9B7488683A4d62d0817E965E8f24ffff"
    },
    "connectionId": [ ],
    "messageSchemaVersion": "1.0.0",
    "messageName": "EventMessage",
    "additionalInformation": { }
}

Volgende stappen

• Integratiepatronen voor slimme contracten