You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This feature provides an implementation of Message Level Encryption (MLE) for APIs provided by CyberSource, integrated within our SDK. This feature ensures secure communication by encrypting messages at the application level before they are sent over the network.
6
+
7
+
## Configuration
8
+
9
+
### Global MLE Configuration
10
+
11
+
In the `merchantConfig` object, set the `useMLEGlobally` variable to enable or disable MLE for all supported APIs for the Rest SDK.
12
+
13
+
-**Variable**: `useMLEGlobally`
14
+
-**Type**: `boolean`
15
+
-**Default**: `false`
16
+
-**Description**: Enables MLE globally for all APIs when set to `true`. If set to `true`, it will enable MLE for all API calls that support MLE by CyberSource, unless overridden by `mapToControlMLEonAPI`.
17
+
18
+
### API-level MLE Control
19
+
20
+
Optionally, you can control the MLE feature at the API level using the `mapToControlMLEonAPI` variable in the `merchantConfig` object.
21
+
22
+
-**Variable**: `mapToControlMLEonAPI`
23
+
-**Type**: `map = [string, boolean]`
24
+
-**Description**: Overrides the global MLE setting for specific APIs. The key is the function name of the API in the SDK, and the value is a boolean indicating whether MLE should be enabled (`true`) or disabled (`false`) for that specific API call.
25
+
26
+
### MLE Key Alias
27
+
28
+
Another optional parameter for MLE is `mleKeyAlias`, which specifies the key alias used to retrieve the MLE certificate from the JWT P12 file.
29
+
30
+
-**Variable**: `mleKeyAlias`
31
+
-**Type**: `string`
32
+
-**Default**: `CyberSource_SJC_US`
33
+
-**Description**: By default, CyberSource uses the `CyberSource_SJC_US` public certificate to encrypt the payload. However, users can override this default value by setting their own key alias.
34
+
35
+
## Notes
36
+
- If `useMLEGlobally` is set to true, it will enable MLE for all API calls that support MLE by CyberSource, unless overridden by mapToControlMLEonAPI.
37
+
- If `mapToControlMLEonAPI` is not provided or does not contain a specific API function name, the global useMLEGlobally setting will be applied.
38
+
- The `mleKeyAlias` parameter is optional and defaults to CyberSource_SJC_US if not specified by the user. Users can override this default value by setting their own key alias.
39
+
40
+
## Example Configuration
41
+
42
+
```php
43
+
// Enable MLE globally for all supported APIs
44
+
$merchantConfig->setUseMLEGlobally(true);
45
+
```
46
+
47
+
Or
48
+
49
+
```php
50
+
// Enable MLE globally for all supported APIs
51
+
$merchantConfig->setUseMLEGlobally(true);
52
+
53
+
// Optionally, control MLE at the API level
54
+
$merchantConfig->setMapToControlMLEonAPI([
55
+
'apiFunctionName1' => false, // Disable MLE for this specific API
56
+
'apiFunctionName2' => true // Enable MLE for this specific API
This feature provides an implementation of Message Level Encryption (MLE) for APIs provided by CyberSource, integrated within our SDK. This feature ensures secure communication by encrypting messages at the application level before they are sent over the network.
107
+
108
+
More information about this new MLE feature can be found in this file : [MLE.md](MLE.md)
109
+
103
110
### MetaKey Support
104
111
105
112
A Meta Key is a single key that can be used by one, some, or all merchants (or accounts, if created by a Portfolio user) in the portfolio.
[[Back to top]](#)[[Back to API list]](../../README.md#documentation-for-api-endpoints)[[Back to Model list]](../../README.md#documentation-for-models)[[Back to README]](../../README.md)
[[Back to top]](#)[[Back to API list]](../../README.md#documentation-for-api-endpoints)[[Back to Model list]](../../README.md#documentation-for-models)[[Back to README]](../../README.md)
Copy file name to clipboardExpand all lines: docs/Api/CreateNewWebhooksApi.md
+2-94Lines changed: 2 additions & 94 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,107 +4,15 @@ All URIs are relative to *https://apitest.cybersource.com*
4
4
5
5
Method | HTTP request | Description
6
6
------------- | ------------- | -------------
7
-
[**createWebhookSubscription**](CreateNewWebhooksApi.md#createWebhookSubscription) | **POST** /notification-subscriptions/v1/webhooks | Create a Webhook
8
-
[**findProductsToSubscribe**](CreateNewWebhooksApi.md#findProductsToSubscribe) | **GET** /notification-subscriptions/v1/products/{organizationId} | Find Products You Can Subscribe To
Create a new webhook subscription. Before creating a webhook, ensure that a security key has been created at the top of this developer center section. You will not need to pass us back the key during the creation of the webhook, but you will receive an error if you did not already create a key or store one on file.
18
-
19
-
### Example
20
-
```php
21
-
<?php
22
-
require_once(__DIR__ . '/vendor/autoload.php');
23
-
24
-
$api_instance = new CyberSource\Api\CreateNewWebhooksApi();
25
-
$createWebhookRequest = new \CyberSource\Model\CreateWebhookRequest(); // \CyberSource\Model\CreateWebhookRequest | The webhook payload
[[Back to top]](#)[[Back to API list]](../../README.md#documentation-for-api-endpoints)[[Back to Model list]](../../README.md#documentation-for-models)[[Back to README]](../../README.md)
Retrieve a list of products and event types that your account is eligible for. These products and events are the ones that you may subscribe to in the next step of creating webhooks.
63
-
64
-
### Example
65
-
```php
66
-
<?php
67
-
require_once(__DIR__ . '/vendor/autoload.php');
68
-
69
-
$api_instance = new CyberSource\Api\CreateNewWebhooksApi();
70
-
$organizationId = "organizationId_example"; // string | The Organization Identifier.
[[Back to top]](#)[[Back to API list]](../../README.md#documentation-for-api-endpoints)[[Back to Model list]](../../README.md#documentation-for-models)[[Back to README]](../../README.md)
Create security keys that CyberSource will use internally to connect to your servers and validate messages using a digital signature. Select the CREATE example for CyberSource to generate the key on our server and maintain it for you as well. Remeber to save the key in the API response, so that you can use it to validate messages later.
15
+
Create security keys that CyberSource will use internally to connect to your servers and validate messages using a digital signature. Select the CREATE example for CyberSource to generate the key on our server and maintain it for you as well. Remember to save the key in the API response, so that you can use it to validate messages later.
108
16
109
17
### Example
110
18
```php
@@ -146,7 +54,7 @@ No authorization required
146
54
### HTTP request headers
147
55
148
56
-**Content-Type**: application/json;charset=utf-8
149
-
-**Accept**: application/json;charset=utf-8
57
+
-**Accept**: application/hal+json;charset=utf-8
150
58
151
59
[[Back to top]](#)[[Back to API list]](../../README.md#documentation-for-api-endpoints)[[Back to Model list]](../../README.md#documentation-for-models)[[Back to README]](../../README.md)
0 commit comments