The basic onboarding flow is common for every brand-new property, regardless of the Akamai product you want to use. Here's how to start serving your content through optimal edge servers.
To make calls through PAPI, you need to authenticate to Akamai using tokens you generate in your API client tool. Make sure you have write access to your primary DNS servers. You'll need to modify DNS records later in this process to onboard the property.
Get the IP address of your existing origin and create an
A record in your DNS.
These identifiers specify what modules and features are available in your configuration.
CP codes track any web traffic handled by edge servers. Each property’s default rule needs a valid CP code to bill and report for the service.
Think of a property as a container for your product configuration. Through properties, you control how your content is delivered.
Map your property to an edge hostname that will take over the client traffic from your origin. If you have Secure By Default enabled in your contract, the easiest way is to specify a setup with a "certificateProvisioningType": "DEFAULT" that secures your HTTPS delivery and automatically creates an edge hostname upon activation.
Note the DNS challenge you receive in the
Confirm that you control the domain name used in the edge certificate. In your DNS configuration, create a CNAME record and map the hostname part of the challenge to the target part.
Re-run the operation to check the
Get the baseline of your property's rule tree. What you'll get in the response varies based on your Akamai product.
Provide necessary details for the top-level default rule. At minimum, configure mandatory
cpCode behaviors. Optionally, include any number of your own rules to customize the content delivery.
Make sure your JSON file is correct and complete before deploying it on edge servers. You need to resolve returned errors, as they block an activation, but you can activate a property version that yields less severe warnings. For more information, see Rule tree errors and warnings. Both VS code and Eclipse plugins support full rule tree validation.
Push the updated JSON file to the property configuration.
With brand new setups, it's enough that you test your configuration on Production. You can activate your property on both networks at the same time.
Make sure the activation status is
After activation, your certificate should be in the
Look up the IP address of your edge hostname and copy it.
Mac OS, Linux, or Unix:
Paste the edge hostname IP address to your local hosts file in a text editor.
Mac OS, Linux, or Unix:
Restart your browser to clear your DNS cache and verify that your site is working the way you expect.
Start serving live traffic through the Akamai Edge Platform. Delete the existing CNAME record and add a new one, setting its value to the Akamai edge hostname.
Remember to remove any entries from your local hosts file you set up for testing. Now you can restart your browser and do a smoke test of your website or application.