-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[EDU-5231] Axur Cardstream guide (#1409)
* feat: add cardstream guide * feat: add pt-br guide * fix: small changes * feat: add links to index * refactor: changes steps to protect a domain * Apply suggestions from code review Co-authored-by: Mariana Bellorín Aguilera <[email protected]> * fix: small changes --------- Co-authored-by: Mariana Bellorín Aguilera <[email protected]>
- Loading branch information
1 parent
ef4a9e9
commit ca5cdc9
Showing
6 changed files
with
418 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
207 changes: 207 additions & 0 deletions
207
src/content/docs/en/pages/guides/marketplace/integrations/cardstream.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,207 @@ | ||
--- | ||
title: How to install the Axur Cardstream integration through Azion Marketplace | ||
description: >- | ||
Protect your e-commerce from fraud with the Axur Cardstream integration. | ||
meta_tags: 'marketplace, security, integrations, e-commerce' | ||
namespace: docs_guides_axur_cardstream | ||
permalink: /documentation/products/guides/axur-cardstream/ | ||
--- | ||
|
||
import Tabs from '~/components/tabs/Tabs' | ||
import InterfaceNote from '~/includes/snippets/InterfaceNote/en/snippet.mdx' | ||
|
||
<InterfaceNote /> | ||
|
||
**Axur Cardstream** is an integration that helps you protect your e-commerce from fraud even on the first purchase and, consequently, avoid the chargeback. | ||
|
||
It's a global list of cards leaked on the Internet, as well as the deep and dark web. With the API active, every time your client makes a purchase, you can check if the card has been exposed, request additional verification, or even cancel the transaction. | ||
|
||
--- | ||
|
||
## Requirements | ||
|
||
To start using this integration, you need to: | ||
|
||
- Create an [Axur account](https://www.axur.com/en-us/). | ||
- Get an Axur **API Token**. | ||
|
||
--- | ||
|
||
## Getting the integration | ||
|
||
To install this integration: | ||
|
||
<Tabs client:visible> | ||
<Fragment slot="tab.console">Console</Fragment> | ||
<Fragment slot="tab.rtm">Real-Time Manager</Fragment> | ||
|
||
<Fragment slot="panel.console"> | ||
1. Access [Azion Console](/en/documentation/products/guides/how-to-access-azion-console/) > **Marketplace**. | ||
2. On the Marketplace homepage, select the **Cardstream** card. | ||
3. On the integration page, click the **Install** button. | ||
|
||
You'll see a message indicating that your integration was successfully installed. | ||
</Fragment> | ||
|
||
<Fragment slot="panel.rtm"> | ||
1. Access [Real-Time Manager (RTM)](https://manager.azion.com/) > **Marketplace**. | ||
2. On the Marketplace homepage, select the **Cardstream** card. | ||
3. On the integration page, click the **Get It Now** button, located at the bottom-right corner of the page. | ||
|
||
You'll see a message indicating that your integration was successfully installed. | ||
</Fragment> | ||
|
||
</Tabs> | ||
|
||
:::tip | ||
You can search any integration by browsing through the cards, using the filters, or typing a keyword in the search bar. | ||
::: | ||
|
||
--- | ||
|
||
## Configuring the integration | ||
|
||
Once you've installed the **Axur Cardstream** integration, you'll need to complete the steps explained below to configure it. | ||
|
||
### Setting up an edge firewall | ||
|
||
Follow the steps: | ||
|
||
<Tabs client:visible> | ||
<Fragment slot="tab.console">Console</Fragment> | ||
<Fragment slot="tab.rtm">Real-Time Manager</Fragment> | ||
|
||
<Fragment slot="panel.console"> | ||
1. On the upper-left corner, open the **Products menu** and select **Edge Firewall** in the **Secure** section. | ||
2. Click the **+ Edge Firewall** button. | ||
3. Give an easy-to-remember name to your edge firewall. | ||
4. Enable the **Edge Functions** switch in the **Modules** section. | ||
- This action gives access to edge functions on your edge firewall. | ||
5. Click the **Save** button. | ||
|
||
Done. Now you've instantiated the edge firewall for your function and have access to edge functions on your edge firewall. | ||
</Fragment> | ||
|
||
<Fragment slot="panel.rtm"> | ||
1. On the upper-left corner, open the **Products menu** and select **Edge Firewall** in the **SECURE** section. | ||
2. Click the **Add Rule Set** button. | ||
3. Give an easy-to-remember name to your edge firewall. | ||
4. Select the domains you want to protect with the function. | ||
5. Enable the **Edge Functions** switch in the **Modules** section. | ||
- This action gives access to edge functions on your edge firewall. | ||
6. Click the **Save** button. | ||
|
||
Done. Now you've instantiated the edge firewall for your function and have access to edge functions on your edge firewall. | ||
</Fragment> | ||
|
||
</Tabs> | ||
|
||
:::caution[Warning] | ||
If a product or module is activated, it could generate usage-related costs. Check the [pricing page](/en/documentation/products/pricing/) for more information. | ||
::: | ||
|
||
### Setting up the Edge Firewall function | ||
|
||
While still on the **Edge Firewall** page: | ||
|
||
<Tabs client:visible> | ||
<Fragment slot="tab.console">Console</Fragment> | ||
<Fragment slot="tab.rtm">Real-Time Manager</Fragment> | ||
|
||
<Fragment slot="panel.console"> | ||
1. Select the **Functions Instances** tab. | ||
2. Click the **+ Function Instance** button. | ||
3. Give an easy-to-remember name to your instance. | ||
4. On the dropdown menu, select the **Axur Cardstream** function. | ||
5. In the **Arguments** box, pass your variables: | ||
|
||
```json | ||
{ | ||
"card_number_field": "cc_number", | ||
"api_key": "YourAxurAPIKey", | ||
} | ||
``` | ||
|
||
Where: | ||
|
||
| Variable | Mandatory | Description | | ||
| ---- | ---- | ---- | | ||
| `card_number_field` | Yes | The number of the credit card used in the transaction | | ||
| `api_key` | Yes | The API Key of your Axur account | | ||
|
||
6. Click the **Save** button. | ||
</Fragment> | ||
|
||
<Fragment slot="panel.rtm"> | ||
1. Select the **Functions** tab. | ||
2. Click the **Add Function** button. | ||
3. Give an easy-to-remember name to your instance. | ||
4. On the dropdown menu, select the **Axur Cardstream** function. | ||
|
||
This action will load the function, showing a form with the function's source code and two tabs: **Code** and **Args**. By clicking on the **Code** tab, you'll be able to navigate through the source code, but won't be able to change it. | ||
|
||
5. In the **Args** tab, pass your variables: | ||
|
||
```json | ||
{ | ||
"card_number_field": "cc_number", | ||
"api_key": "YourAxurAPIKey", | ||
} | ||
``` | ||
|
||
Where: | ||
|
||
| Variable | Mandatory | Description | | ||
| ---- | ---- | ---- | | ||
| `card_number_field` | Yes | The number of the credit card used in the transaction | | ||
| `api_key` | Yes | The API Key of your Axur account | | ||
|
||
6. Click the **Save** button. | ||
</Fragment> | ||
|
||
</Tabs> | ||
|
||
### Setting up the Rules Engine | ||
|
||
To finish, you must set up a rule in **Rules Engine** to configure the **criteria** and the **behavior** to run the function. | ||
|
||
Still in the **Edge Firewall** page: | ||
|
||
<Tabs client:visible> | ||
<Fragment slot="tab.console">Console</Fragment> | ||
<Fragment slot="tab.rtm">Real-Time Manager</Fragment> | ||
|
||
<Fragment slot="panel.console"> | ||
1. Select the **Rules Engine** tab. | ||
2. Click the **+ Rule Engine** button. | ||
3. Give an easy-to-remember name to the rule. | ||
4. Select a *criteria* to run and catch the domains that you want to run the integration on. | ||
- Example: if `Host` *matches* `yourdomain.com`. | ||
5. Below, select a *behavior* to the *criteria*. In this case, it'll be **Run Function**. | ||
- Select the adequate function according to the name you gave it in the instantiate step. | ||
6. Click the **Save** button. | ||
|
||
On the Console, you must now configure your domain so it is protected by your Edge Firewall. | ||
|
||
7. On the **Products menu**, select **Domains**. | ||
8. Click on the domain you want to protect with your **Cardstream** function. | ||
9. In the **Settings** section, click on the `Edge Firewall` selector and choose the Edge Firewall you've just created. | ||
10. Click the **Save** button. | ||
|
||
Done. Now the **Axur Cardstream** integration is running. | ||
</Fragment> | ||
|
||
<Fragment slot="panel.rtm"> | ||
1. Select the **Rules Engine** tab. | ||
2. Click the **New Rule** button. | ||
3. Give an easy-to-remember name to the rule. | ||
4. Select a *criteria* to run and catch the domains that you want to run the integration on. | ||
- Example: if `Host` *matches* `yourdomain.com`. | ||
5. Below, select the **Run Function** *behavior* to the *criteria*. | ||
6. Select the **Axur Cardstream** function according to the name you gave it before. | ||
7. Click the **Save** button. | ||
|
||
Done. Now the **Axur Cardstream** integration is running. | ||
</Fragment> | ||
|
||
</Tabs> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.