This article provides step-by-step instructions for adding Cequence EdgeWorker to an Akamai property and configuring the property's variables for use with Cequence EdgeWorker.

Prerequisites

Before you add Cequence EdgeWorker to an Akamai property, confirm that your environment meets the following prerequisites.

• Access to Akamai Control Center
• Appropriate permissions to manage EdgeWorkers and Properties
• A Cequence account and access to Cequence UAP Portal
• In the Cequence UAP Portal, generate Client Id (say akamai-edgeworker-client) and Client Secret with Traffic Management permissions and Token Lifespan of 1800 seconds
• The compressed tgz file that contains the Cequence EdgeWorker

Cequence Akamai EdgeWorker

Creating an EdgeWorker in Akamai

1. Log in to the Akamai Control Center.
2. Navigate to EdgeWorkers from the left sidebar.
3. Click on Create EdgeWorker button.
4. Fill in the required information.
   • Name: "Cequence EdgeWorker 1"
   • Description: "Cequence API Security and Bot Protection EdgeWorker"
5. Choose the defaults for Group, Contract ID and Resource tier.
6. Click Create.

Uploading Cequence EdgeWorker Code

1. Click the ID associated with the newly created EdgeWorker.
2. In the EdgeWorker ID details page, select the Versions tab.
3. Click Create Version.
4. Choose the Cequence EdgeWorker code file (.tgz) you downloaded earlier.
5. Click Create Version.

Activating EdgeWorker Version

1. Select the version to activate
2. Click Activate version and choose the network.
   Network options are Staging or Production.
3. Confirm the activation.

Attaching the Cequence EdgeWorker to a Property

1. In the Property Manager, select the the property you want to attach the EdgeWorker to; say api.mycompany.com
2. Click "New Version" under "Active Staging Version" or "Active Production Version"
3. Under Property Variables, click + Variables to add each of the following variables
   
   • Name: "CEQUENCE_CLIENT_ID"
     Type: String
     Value: Your Cequence Client ID generated from the UAP Portal in the prerequisites phase
   • Name: "CEQUENCE_CLIENT_SECRET"
     Type: String
     Value: Your Cequence Client Secret generated from the UAP Portal in the prerequisites phase
   • Name: "CEQUENCE_HOSTNAME"
     Type: String
     Value: Copy and paste the value from "Property Hostname"
   • (Optional) Name: "CEQUENCE_AUTH_TOKEN_URI"
     Type: String
     Value: Alternative token URI for authentication, if not /auth/realms/cequence/protocol/openid-connect/token
4. Confirm that sensitive variables, such as CEQUENCE_CLIENT_SECRET, are marked Hidden.
5. Click Save to save the variables.
6. Add Cequence EdgeWorker Rule
   1. In Property Configuration Settings, click + Rules.
   2. Select Blank Rule Template.
   3. In Name, type Cequence EdgeWorker and click Insert Rule.
   4. In the Behaviors section, add a new Standard property behavior.
   5. Search for and select EdgeWorkers, then click Insert Behavior.
   6. In EdgeWorker Identifier, select the ID or name of the EdgeWorker assigned, such as Cequence EdgeWorker 1.
   7. Click + Match, If: Path matches one of /*
7. Add Cequence Edge Origin Rule
   1. In Property Configuration Settings, click + Rules.
   2. Select Blank Rule Template, call the new rule "Cequence Edge Origin Rule", then click Insert Rule.
   3. In the Behaviors section of this rule, add a new Standard property behavior.
   4. Click Add Behavior.
   5. Search for and select Origin Server.
   6. Configure the following behavior settings.
      • Click + Match, If: Path matches one of: /api-transactions
      • Origin Type: Your Origin
      • Origin Server Hostname: The hostname for Cequence Edge, for example, edge.yourcompany.1.cequence.cloud
      • Forward Host Header: Origin Hostname
      • Cache Key Hostname: Origin Hostname
   7. Add Cequence Auth Origin Rule
      1. In Property Configuration Settings, click + Rules.
      2. Select the Blank Rule Template, call the new rule Cequence Auth Origin Rule, and click Insert Rule.
      3. In the Behaviors section, add a new Standard property behavior.
      4. Click "Add Behavior"
      5. Search for and select Origin Server
      6. Configure the behavior as follows:
         • Click + Match, If: Path matches one of: /auth/realms/cequence/protocol/openid-connect/token
         • Origin Type: Your Origin
         • Origin Server Hostname: The hostname for Cequence Auth (e.g., auth.yourcompany.1.cequence.cloud)
         • Forward Host Header: Origin Hostname
         • Cache Key Hostname: Origin Hostname
      7. Add another behavior to cache post responses, click "Add Behavior"
      8. Search for and select Cache POST Responses
      9. Configure the behavior as follows:
         • Status: On
         • POST Body: Include the MD5 hash in cache key
      10. Add another behavior to set cache TTL, click "Add Behavior"
      11. Search for and select Caching
      12. Configure the behavior as follows:
          • Caching option: Cache
          • Force revalidation of stale objects: Always revalidate with origin
          • Maxage: 1700 seconds (this assumes the token lifespan set for CEQUENCE_CLIENT_ID is greater that 1700 seconds; default is 1800 seconds)

Saving and Activating Property

1. Save your property changes
2. Go through the validation process
3. Activate the property on Staging for testing
4. Once tested and verified with Cequence, activate on Production

Troubleshooting

If you encounter issues:

• Check the EdgeWorker logs in the Akamai Control Center
• Verify that the EdgeWorker ID in the property matches your Cequence EdgeWorker
• Ensure all required Cequence variables are correctly defined and not exposed
• Confirm that your Cequence account is active and properly configured
• Verify that the CEQUENCE_CLIENT_ID and CEQUENCE_CLIENT_SECRET match the credentials provided by Cequence