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
Update JS Agent example from v3 to v4 using the new agent API. Remove
unnecessary terraform variable block examples as they are no longer
required. Update repository URL. Update documentation links.
Related-Task: INTER-2047
[Fingerprint](https://fingerprint.com) is a device intelligence platform offering industry-leading accuracy.
18
+
[Fingerprint][fingerprint] is a device intelligence platform offering industry-leading accuracy.
19
19
20
20
Fingerprint Akamai Proxy Integration is responsible for proxying identification and agent-download requests between your website and Fingerprint through your Akamai infrastructure. The integration consists of a set of property rules you need to add to your Akamai property configuration. The property rules template is available in this repository.
21
21
22
22
## 🚧 Requirements and expectations
23
23
24
-
***Limited to Enterprise plan**: The Akamai Proxy Integration is accessible and exclusively supported for customers on the **Enterprise** Plan. Other customers are encouraged to use [Custom subdomain setup](https://dev.fingerprint.com/docs/custom-subdomain-setup) or [Cloudflare Proxy Integration](https://dev.fingerprint.com/docs/cloudflare-integration).
24
+
***Limited to Enterprise plan**: The Akamai Proxy Integration is accessible and exclusively supported for customers on the **Enterprise** Plan. Other customers are encouraged to use [Custom subdomain setup][custom-subdomain-setup] or [Cloudflare Proxy Integration][cloudflare-proxy-integration].
25
25
26
26
***Manual updates occasionally required**: The underlying data contract in the identification logic can change to keep up with browser updates. Using the Akamai Proxy Integration might require occasional manual updates on your side. Ignoring these updates will lead to lower accuracy or service disruption.
27
27
@@ -30,13 +30,12 @@ Fingerprint Akamai Proxy Integration is responsible for proxying identification
30
30
> [!NOTE]
31
31
> This section assumes you use Terraform to manage your site infrastructure on Akamai and that your site uses the `latest` Akamai rule format.
32
32
> * If you do not use Terraform, see [How to install without Terraform](#how-to-install-using-akamai-property-manager-api-without-terraform).
33
-
> * If your Akamai property uses a different rule format, please contact our [support team](https://fingerprint.com/support/).
33
+
> * If your Akamai property uses a different rule format, please contact our [support team][support].
34
34
35
+
This is a quick overview of the installation setup. For detailed step-by-step instructions, see the [Akamai proxy integration guide in our documentation][akamai-guide].
35
36
36
-
This is a quick overview of the installation setup. For detailed step-by-step instructions, see the [Akamai proxy integration guide in our documentation](https://dev.fingerprint.com/docs/akamai-proxy-integration).
37
-
38
-
1. Go to Fingerprint **Dashboard** > [**API Keys**](https://dashboard.fingerprint.com/api-keys) and click **Create Proxy Key** to create a proxy secret. You will use it later to authenticate your requests to Fingerprint APIs.
39
-
2. Add the following variable blocks to the Akamai property [Rules template](https://techdocs.akamai.com/terraform/docs/pm-ds-rules-template) in your Terraform configuration file. If you are using a plain JSON file instead of a rules template, reach out to our [support team](https://fingerprint.com/support/).
37
+
1. Go to Fingerprint **Dashboard** > [**API Keys**][fingerprint-api-keys] and click **Create Proxy Key** to create a proxy secret. You will use it later to authenticate your requests to Fingerprint APIs.
38
+
2. Add the following variable blocks to the Akamai property [Rules template][akamai-ref-rules-template] in your Terraform configuration file. If you are using a plain JSON file instead of a rules template, reach out to our [support team][support].
40
39
41
40
```tf
42
41
# main.tf
@@ -48,16 +47,6 @@ This is a quick overview of the installation setup. For detailed step-by-step in
48
47
value = "YOUR_INTEGRATION_PATH_HERE" # any random string that's a valid URL
49
48
type = "string"
50
49
}
51
-
variables {
52
-
name = "fpjs_agent_path"
53
-
value = "YOUR_AGENT_PATH_HERE" # any random string that's a valid URL
54
-
type = "string"
55
-
}
56
-
variables {
57
-
name = "fpjs_result_path"
58
-
value = "YOUR_RESULT_PATH_HERE" # any random string that's a valid URL
59
-
type = "string"
60
-
}
61
50
variables {
62
51
name = "fpjs_proxy_secret"
63
52
value = "YOUR_PROXY_SECRET_HERE" # Use the proxy secret from the previous step
@@ -66,7 +55,7 @@ This is a quick overview of the installation setup. For detailed step-by-step in
66
55
}
67
56
```
68
57
69
-
3. Go to this repository [latest releases](https://github.com/fingerprintjs/fingerprint-pro-akamai-integration-property-rules/releases/latest) and download these two JSON files:
58
+
3. Go to this repository [latest releases][latest-releases] and download these two JSON files:
70
59
* `terraform-fingerprint-property-rules.json`
71
60
* `terraform-fingerprint-property-variables.json`
72
61
4. Add the files to the `rules` directory of your Terraform project.
@@ -93,25 +82,18 @@ This is a quick overview of the installation setup. For detailed step-by-step in
93
82
```
94
83
95
84
6. Run `terraform plan` to review your changes and `terraform apply` to deploy them.
96
-
7. Configure the Fingerprint [JS Agent](https://dev.fingerprint.com/docs/js-agent) on your website using the paths defined in Step 2.
85
+
7. Configure the Fingerprint [JS Agent][js-agent-v4] on your website using the paths defined in Step 2.
97
86
98
87
```javascript
99
-
import * as FingerprintJS from '@fingerprintjs/fingerprintjs-pro'
See the [Akamai proxy integration guide](https://dev.fingerprint.com/docs/deploy-akamai-proxy-integration-via-terraform#step-3-add-variable-blocks-to-your-rules-template) in our documentation for more details.
96
+
See the [Akamai proxy integration guide][akamai-guide-step-3] in our documentation for more details.
115
97
116
98
### Building property rules for Terraform locally
117
99
@@ -124,23 +106,37 @@ If you prefer, you can clone this repository and build the property rules and va
The JSON files are equivalent to the JSON files available in the [latest releases](https://github.com/fingerprintjs/fingerprint-pro-akamai-integration-property-rules/releases/latest).
109
+
The JSON files are equivalent to the JSON files available in the [latest releases][latest-releases].
128
110
129
111
## How to install using Akamai Property Manager API (without Terraform)
130
112
131
-
You can clone this repository and build the property rules locally into a single `body.json` file. You can then apply them as a patch update to your property configuration using Akamai [Property Manager API](https://techdocs.akamai.com/property-mgr/reference/api). This allows you to install the integration in an automated way even if you do not use Terraform.
113
+
You can clone this repository and build the property rules locally into a single `body.json` file. You can then apply them as a patch update to your property configuration using Akamai [Property Manager API][akamai-ref-papi]. This allows you to install the integration in an automated way even if you do not use Terraform.
* Use the same values you would use in [Step 2](#how-to-install-with-terraform) if you were installing with Terraform.
137
119
* The command generates a `dist/patch-body/body.json` file. This file includes all rules and property variables necessary for the integration.
138
-
3. Use the [Patch a property's rule tree](https://techdocs.akamai.com/property-mgr/reference/patch-property-version-rules) endpoint of the Akamai Property Manager API to apply the generated JSON to your Akamai property.
120
+
3. Use the [Patch a property's rule tree][akamai-ref-patch-property-version-rules] endpoint of the Akamai Property Manager API to apply the generated JSON to your Akamai property.
139
121
140
-
For detailed instructions please see the [Deploy Akamai Integration using Property Manager API](https://dev.fingerprint.com/docs/deploy-akamai-proxy-integration-via-papi) documentation.
122
+
For detailed instructions please see the [Deploy Akamai Integration using Property Manager API][akamai-guide-deploy-via-papi] documentation.
141
123
142
-
If you have any questions, reach out to our [support team](https://fingerprint.com/support).
124
+
If you have any questions, reach out to our [support team][support].
143
125
144
126
## License
145
127
146
-
This project is licensed under the MIT license. See the [LICENSE](https://github.com/fingerprintjs/fingerprint-pro-akamai-integration-property-rules/blob/main/LICENSE) file for more info.
128
+
This project is licensed under the MIT license. See the [LICENSE](LICENSE) file for more info.
0 commit comments