Skip to content

Commit

Permalink
Merge branch 'main' into broken_link
Browse files Browse the repository at this point in the history
  • Loading branch information
keharper authored Dec 13, 2024
2 parents 6fb1e8b + c1220fa commit f4533a2
Show file tree
Hide file tree
Showing 10 changed files with 110 additions and 24 deletions.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"url": "https://github.com/AdobeDocs/commerce-extensibility"
},
"dependencies": {
"@adobe/gatsby-theme-aio": "4.14.13",
"@adobe/gatsby-theme-aio": "4.14.17",
"gatsby": "4.22.0",
"react": "^17.0.2",
"react-dom": "^17.0.2"
Expand Down
6 changes: 6 additions & 0 deletions src/pages/admin-ui-sdk/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,3 +33,9 @@ The following sequence diagram illustrates the authentication process.
## Code samples

The [Adobe Commerce Samples repository](https://github.com/adobe/adobe-commerce-samples/tree/main/admin-ui-sdk) contains samples for different extension points of the Adobe Commerce Admin UI SDK. Use these samples to gain insight on how the Admin SDK injects menus and pages into the Admin.

## Admin UI SDK and Adobe Extensions

Adobe App Builder supports [extensions](https://developer.adobe.com/app-builder/docs/guides/extensions/), which allow developers to integrate their applications with specific Adobe products, such as the Admin UI SDK. Extensions act as a bridge between Adobe products and the applications built using Adobe App Builder. As a result, these applications can be easily integrated and extended within Adobe's ecosystem.

App Builder projects support `application` and `extension` configurations within the `app.config.yaml` file. The Admin UI SDK supports both of these types as well. The SDK is not affected if you [migrate](https://developer.adobe.com/app-builder/docs/guides/extensions/extension_migration_guide/) an existing App Builder project that uses an `application` configuration to use an `extension` configuration.
8 changes: 7 additions & 1 deletion src/pages/admin-ui-sdk/publish.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,13 @@ During the testing phase, an administrator of your enterprise organization perfo

## Update an already published application

To update an already published application, you must revoke it and go through the approval process again.
To deploy code changes to an already published application, you can perform a force deploy:

```bash
aio app deploy --force-deploy
```

To update the credentials or services used by an already published application, you must revoke it and go through the approval process again.

1. Ask an enterprise organization administrator to revoke your published application in the [Adobe Exchange Manage panel](https://exchange.adobe.com/manage). Note that once revoked, your application will no longer be public.

Expand Down
32 changes: 32 additions & 0 deletions src/pages/events/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,3 +140,35 @@ curl -i -X PUT \
}' \
'<ADOBE_COMMERCE_URL>/rest/all/V1/eventing/updateConfiguration'
```

## Get configured event provider information

The `GET /rest/<store_view_code>/V1/eventing/getEventProviders` endpoint returns information about the event provider configured for the Commerce instance.

**Headers:**

`Authorization: Bearer <administrator token>`

The administrator must be granted access to the `Magento_AdobeIoEventsClient::event_provider_list` resource.

**Example usage:**

The following cURL command retrieves information about the configured event provider:

```bash
curl -H "Authorization:Bearer <AUTH_TOKEN>" \
'<ADOBE_COMMERCE_URL>/rest/all/V1/eventing/getEventProviders' \
```

**Example response:**

```json
[
{
"provider_id": "ad667bc6-1678-49ff-99fc-215d71ebf82f",
"instance_id": "my_instance",
"label": "my_provider",
"description": "Provides out-of-process extensibility for Adobe Commerce"
}
]
```
4 changes: 2 additions & 2 deletions src/pages/events/convert-field-values.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,8 @@ In the following example, the `TestConverterVisibility` converter class updates
```php
<?php
/**
* Copyright &copy; Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
* Copyright [first year code created] Adobe
* All rights reserved.
*/
declare(strict_types=1);

Expand Down
4 changes: 2 additions & 2 deletions src/pages/events/custom-event-fields.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,8 +74,8 @@ In the following example, the `TestProcessorOrderStatus` class adds the `order_s
```php
<?php
/**
* Copyright &copy; Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
* Copyright [first year code created] Adobe
* All rights reserved.
*/
declare(strict_types=1);
Expand Down
10 changes: 10 additions & 0 deletions src/pages/events/release-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,16 @@ These release notes describe the latest version of Adobe I/O Events for Adobe Co

See [Update Adobe I/O Events for Adobe Commerce](installation.md#update-adobe-io-events-for-adobe-commerce) for upgrade instructions.

## Version 1.10.0

### Release date

December 10, 2024

### Enhancements

* Added the `GET /rest/<store_view_code>/V1/eventing/getEventProviders` REST endpoint for retrieving information about the configured event provider. <!---CEXT-3913 -->

## Version 1.9.0

### Release date
Expand Down
2 changes: 1 addition & 1 deletion src/pages/webhooks/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ The resolution of a remote call also determines whether you should implement a w

Use these guidelines to develop your own webhooks:

1. Identify the Adobe Commerce event that triggers a webhook. Adobe Commerce merchants can browse the available events from the Admin by selecting **System** > Events > **Events** to display the Events list page.
1. Identify the Adobe Commerce event that triggers a webhook. Adobe Commerce merchants can browse the available events from the Admin by selecting **System** > Events > **Events List** to display the Events list page.

1. Understand the default payload of the corresponding webhook by running the [`bin/magento webhooks:info` command](commands.md#display-the-payload-of-a-webhook).

Expand Down
38 changes: 35 additions & 3 deletions src/pages/webhooks/signature-verification.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,27 @@ To verify the signature in the App Builder action, set the `raw-http` annotation
raw-http: true
```
Store the public key in the `PUBLIC_KEY` parameter in the `.env` file using the same format as provided in the Adobe Commerce Admin:

```env
# Other secrets and configuration
# ...............................
PUBLIC_KEY="-----BEGIN PUBLIC KEY-----
MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAtglXYVz5pVn3HDluGG5T
t9coO5NKSWjx3xCDMHVa3CEqVM76PKg8UJH9fQOA57xoNv7Llc916pF0UswtudQh
Fyg+WQCFFadqGZOyL2nUKI9xWBiUi4dN8+9yMd3TE1fszVUBnk/XdLKNDQn4O6ic
doQZi5arrjNjInkimtcT2jPXs34p9G9P5CvCubPUmbGsWDgwo5an9LEX/nJfnCdZ
R10XPkRWzEM7o1OGzf7CYo06Xl+msGVM02Er265PsMAWB11cWwKmyg6dLPa8q+Qh
KNXZiEMvdVusV8aA6EkCZYFdWSBXv+jltn6NnY5qvYcuQ3SujQ9xKEANjeMWcW90
PwIDAQAB
-----END PUBLIC KEY-----"
```

**Note:** Do not commit the `.env` file to version control.

[App Builder Configuration Files](https://developer.adobe.com/app-builder/docs/guides/configuration/#env) describes `.env` file usage in detail.

The following code example below shows how the signature can be verified in the App Builder action:

```javascript
Expand All @@ -109,9 +130,20 @@ async function main (params) {
if (isSignatureValid) {
logger.info('The signature is valid.');
// Here will be performed real action logic
operations.push({
op: 'success'
});
// payload is base64 encoded, so we need to decode it before using
const payload = JSON.parse(atob(params.__ow_body))
// a simple validation if the provided postcode from Commerce webhook is less than 50000
if (payload.address.postcode > 50000) {
operations.push({
op: 'exception',
message: 'The postcode is not allowed. Provided postcode: ' + payload.address.postcode
});
} else {
operations.push({
op: 'success'
});
}
} else {
logger.info('The signature is invalid.');
operations.push({
Expand Down
28 changes: 14 additions & 14 deletions yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,9 @@ __metadata:
languageName: node
linkType: hard

"@adobe/gatsby-theme-aio@npm:4.14.13":
version: 4.14.13
resolution: "@adobe/gatsby-theme-aio@npm:4.14.13"
"@adobe/gatsby-theme-aio@npm:4.14.17":
version: 4.14.17
resolution: "@adobe/gatsby-theme-aio@npm:4.14.17"
dependencies:
"@adobe/focus-ring-polyfill": ^0.1.5
"@adobe/gatsby-source-github-file-contributors": ^0.3.1
Expand Down Expand Up @@ -131,7 +131,7 @@ __metadata:
gatsby: ^4.22.0
react: ^17.0.2
react-dom: ^17.0.2
checksum: 00ce55db9ec96c66f31a0b83298fbccf40c8a28355c3effcb3525892fcbb5c785d5b18de38e31d8233887e32230178b408d4136f070ba256bfb473812ee53e90
checksum: 929ed9cc32b048ec243dbcd75be3ee822294946e336600bf57b67490632fcd0a0e375e4683a2980eb756b80ee023d5e9605dd91a6a6ebc910d6dac08530aee13
languageName: node
linkType: hard

Expand Down Expand Up @@ -7337,7 +7337,7 @@ __metadata:
version: 0.0.0-use.local
resolution: "commerce-extensibility@workspace:."
dependencies:
"@adobe/gatsby-theme-aio": 4.14.13
"@adobe/gatsby-theme-aio": 4.14.17
gatsby: 4.22.0
react: ^17.0.2
react-dom: ^17.0.2
Expand Down Expand Up @@ -7695,15 +7695,15 @@ __metadata:
linkType: hard

"cross-spawn@npm:^6.0.0, cross-spawn@npm:^6.0.5":
version: 6.0.5
resolution: "cross-spawn@npm:6.0.5"
version: 6.0.6
resolution: "cross-spawn@npm:6.0.6"
dependencies:
nice-try: ^1.0.4
path-key: ^2.0.1
semver: ^5.5.0
shebang-command: ^1.2.0
which: ^1.2.9
checksum: f893bb0d96cd3d5751d04e67145bdddf25f99449531a72e82dcbbd42796bbc8268c1076c6b3ea51d4d455839902804b94bc45dfb37ecbb32ea8e54a6741c3ab9
checksum: a6e2e5b04a0e0f806c1df45f92cd079b65f95fbe5a7650ee1ab60318c33a6c156a8a2f8b6898f57764f7363ec599a0625e9855dfa78d52d2d73dbd32eb11c25e
languageName: node
linkType: hard

Expand Down Expand Up @@ -8764,8 +8764,8 @@ __metadata:
linkType: hard

"elliptic@npm:^6.5.3, elliptic@npm:^6.5.5":
version: 6.5.7
resolution: "elliptic@npm:6.5.7"
version: 6.6.0
resolution: "elliptic@npm:6.6.0"
dependencies:
bn.js: ^4.11.9
brorand: ^1.1.0
Expand All @@ -8774,7 +8774,7 @@ __metadata:
inherits: ^2.0.4
minimalistic-assert: ^1.0.1
minimalistic-crypto-utils: ^1.0.1
checksum: af0ffddffdbc2fea4eeec74388cd73e62ed5a0eac6711568fb28071566319785df529c968b0bf1250ba4bc628e074b2d64c54a633e034aa6f0c6b152ceb49ab8
checksum: e912349b883e694bfe65005214237a470c9a098a6ba36fd24396d0ab07feb399920c0738aeed1aed6cf5dca9c64fd479e212faed3a75c9d81453671ef0de5157
languageName: node
linkType: hard

Expand Down Expand Up @@ -15352,11 +15352,11 @@ __metadata:
linkType: hard

"nanoid@npm:^3.3.4":
version: 3.3.4
resolution: "nanoid@npm:3.3.4"
version: 3.3.8
resolution: "nanoid@npm:3.3.8"
bin:
nanoid: bin/nanoid.cjs
checksum: 2fddd6dee994b7676f008d3ffa4ab16035a754f4bb586c61df5a22cf8c8c94017aadd360368f47d653829e0569a92b129979152ff97af23a558331e47e37cd9c
checksum: dfe0adbc0c77e9655b550c333075f51bb28cfc7568afbf3237249904f9c86c9aaaed1f113f0fddddba75673ee31c758c30c43d4414f014a52a7a626efc5958c9
languageName: node
linkType: hard

Expand Down

0 comments on commit f4533a2

Please sign in to comment.