Skip to content

Commit bb994ba

Browse files
committed
docs: update README for API v4
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
1 parent 6592958 commit bb994ba

1 file changed

Lines changed: 33 additions & 37 deletions

File tree

README.md

Lines changed: 33 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -8,20 +8,20 @@
88
</a>
99
</p>
1010
<p align="center">
11-
<a href="https://github.com/fingerprintjs/fingerprint-pro-akamai-proxy-integration"><img src="https://img.shields.io/github/v/release/fingerprintjs/fingerprint-pro-akamai-proxy-integration" alt="Current version"></a>
11+
<a href="https://github.com/fingerprintjs/akamai-proxy"><img src="https://img.shields.io/github/v/release/fingerprintjs/akamai-proxy" alt="Current version"></a>
1212
<a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/:license-mit-blue.svg" alt="MIT license"></a>
1313
<a href="https://discord.gg/39EpE2neBg"><img src="https://img.shields.io/discord/852099967190433792?style=logo&label=Discord&logo=Discord&logoColor=white" alt="Discord server"></a>
1414
</p>
1515

1616
# Fingerprint Pro Akamai Proxy Integration
1717

18-
[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.
1919

2020
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.
2121

2222
## 🚧 Requirements and expectations
2323

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].
2525

2626
* **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.
2727

@@ -30,13 +30,12 @@ Fingerprint Akamai Proxy Integration is responsible for proxying identification
3030
> [!NOTE]
3131
> This section assumes you use Terraform to manage your site infrastructure on Akamai and that your site uses the `latest` Akamai rule format.
3232
> * 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].
3434
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].
3536

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].
4039

4140
```tf
4241
# main.tf
@@ -48,16 +47,6 @@ This is a quick overview of the installation setup. For detailed step-by-step in
4847
value = "YOUR_INTEGRATION_PATH_HERE" # any random string that's a valid URL
4948
type = "string"
5049
}
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-
}
6150
variables {
6251
name = "fpjs_proxy_secret"
6352
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
6655
}
6756
```
6857
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:
7059
* `terraform-fingerprint-property-rules.json`
7160
* `terraform-fingerprint-property-variables.json`
7261
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
9382
```
9483
9584
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.
9786
9887
```javascript
99-
import * as FingerprintJS from '@fingerprintjs/fingerprintjs-pro'
88+
import * as Fingerprint from '@fingerprint/agent'
10089
101-
const fpPromise = FingerprintJS.load({
90+
const fp = Fingerprint.start({
10291
apiKey: 'PUBLIC_API_KEY',
103-
scriptUrlPattern: [
104-
'https://yourwebsite.com/YOUR_INTEGRATION_PATH_HERE/YOUR_AGENT_PATH_HERE?apiKey=<apiKey>&version=<version>&loaderVersion=<loaderVersion>',
105-
FingerprintJS.defaultScriptUrlPattern, // Fallback to default CDN in case of error
106-
],
107-
endpoint:
108-
'https://yourwebsite.com/YOUR_INTEGRATION_PATH_HERE/YOUR_RESULT_PATH_HERE?region=us',
109-
FingerprintJS.defaultEndpoint // Fallback to default endpoint in case of error
110-
],
92+
endpoints: 'https://yourwebsite.com/YOUR_INTEGRATION_PATH_HERE',
11193
});
11294
```
11395
114-
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.
11597
11698
### Building property rules for Terraform locally
11799
@@ -124,23 +106,37 @@ If you prefer, you can clone this repository and build the property rules and va
124106
- `dist/terraform/terraform-fingerprint-property-variables.json`
125107
- `dist/terraform/example.tf`
126108
127-
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].
128110
129111
## How to install using Akamai Property Manager API (without Terraform)
130112
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.
132114
133115
134116
1. Run `pnpm install`.
135117
2. Run `pnpm build --type patchBody --integration-path YOUR_INTEGRATION_PATH_HERE --agent-path YOUR_AGENT_PATH_HERE --result-path YOUR_RESULT_PATH_HERE --proxy-secret YOUR_PROXY_SECRET_HERE`.
136118
* Use the same values you would use in [Step 2](#how-to-install-with-terraform) if you were installing with Terraform.
137119
* 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.
139121
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.
141123
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].
143125
144126
## License
145127
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.
129+
130+
[akamai-guide]: https://docs.fingerprint.com/docs/akamai-proxy-integration
131+
[akamai-guide-deploy-via-papi]: https://docs.fingerprint.com/docs/deploy-akamai-proxy-integration-via-papi
132+
[akamai-guide-step-3]: https://docs.fingerprint.com/docs/deploy-akamai-proxy-integration-via-terraform#step-3-add-variable-blocks-to-your-rules-template
133+
[akamai-ref-papi]: https://techdocs.akamai.com/property-mgr/reference/api
134+
[akamai-ref-patch-property-version-rules]: https://techdocs.akamai.com/property-mgr/reference/patch-property-version-rules
135+
[akamai-ref-rules-template]: https://techdocs.akamai.com/terraform/docs/pm-ds-rules-template
136+
[cloudflare-proxy-integration]: https://docs.fingerprint.com/docs/cloudflare-integration
137+
[custom-subdomain-setup]: https://docs.fingerprint.com/docs/custom-subdomain-setup
138+
[fingerprint]: https://fingerprint.com
139+
[fingerprint-api-keys]: https://dashboard.fingerprint.com/api-keys
140+
[js-agent-v4]: https://docs.fingerprint.com/reference/js-agent-v4
141+
[latest-releases]: https://github.com/fingerprintjs/akamai-proxy/releases/latest
142+
[support]: https://fingerprint.com/support/

0 commit comments

Comments
 (0)