Getting Started with F5 DeviceID+

Follow the steps on this page to get your application onboard with F5 DeviceID+.

Subscribe to the F5 DeviceID+ Service

DeviceID+ is currently offered as a free service. To initiate your free subscription, go to F5 Cloud Services home page and in the DeviceID+ section click Subscribe Free.

Onboard Your Application with DeviceID+

There are two methods for onboarding your application with DeviceID+:

  • Deploy DeviceID+ with a JavaScript snippet
  • Deploy DeviceID+ with the BIG-IP

Both methods are described here.

Deploy DeviceID+ with a JavaScript Snippet

To deploy DeviceID+ with a JavaScript snippet:

  1. In the Cloud Services portal, click the DeviceID+ icon in the vertical menu on the left side of the screen.

    _images/CS-DeviceID-option.png

    The DeviceID+ entry page appears.

  2. In the DeviceID+ entry page, click Get Started.

    On the right side of the screen, the Select JS Injection Method pane appears.

  3. In the Select JS Injection Method pane, click JS Snippet and then click Next.

    _images/CD-DeviceID-select-js-snippet-inject-method.png

    Instructions for enabling DeviceID+ with the JS snippet appear on the right side of the screen.

  4. Follow the instructions for enabling the DeviceID+ with the JS snippet, and when you are done click Done.

    That’s it, you’re done. DeviceID+ has now been deployed on your web application.

Deploy DeviceID+ with the BIG-IP

You deploy DeviceID+ with the BIG-IP by creating a BIG-IP iApp.

To create the BIG-IP iApp:

  1. In the Cloud Services portal, click the DeviceID+ icon in the vertical menu on the left side of the screen.

    _images/CS-DeviceID-option.png

    The DeviceID+ entry page appears.

  2. In the DeviceID+ entry page, click Get Started.

    On the right side of the screen, the Select JS Injection Method pane appears.

  3. In the Select JS Injection Method pane, click BIG-IP iApp and then click Next.

    _images/CD-DeviceID-select-bigip-iapp-inject-method.png

    Instructions for enabling DeviceID+ with the BIG-IP appear on the right side of the screen.

  4. Logon to your BIG-IP account.

  5. In the Cloud Services portal, at step 2 in the instructions, download the DeviceID+ iApp template.

  6. In the Main tab in the BIG-IP, go to iApps>Templates>Templates.

    _images/CS-DeviceID-select-iApp-template.png
  7. Click Import.

    The Template Properties screen appears.

  8. In the Template Properties screen, click Choose File, select the DeviceID+ iApp template that you downloaded, and then click Upload.

    You should now see the template you selected in the Template List.

  9. In the Main tab in the BIG-IP, go to iApps>Application Services>Applications.

  10. Click Create.

    _images/CS-DeviceID-create-iApp.png

    The New Application Service screen appears.

  11. Assign a name to the iApp.

  12. From the Template list, select the imported DeviceID+ iApp template.

    The DeviceID+ iApp template configuration settings appear.

    _images/CS-DeviceID-iAppSettings.png
  13. In the Cloud Services portal, at step 4 in the instructions, copy the link.

  14. Back in the BIG-IP, paste the link at Shape JS URL.

  15. At Application’s Virtual Server(s) to Protect, select your web application’s virtual server(s).

    Note

    1. Selecting at least one virtual server is mandatory. Your iApp will not run if it is not assigned to at least one virtual server.
    2. The virtual server(s) you select here must have an HTTP profile attached to it. If you select a virtual server that does not have an HTTP profile attached to it, you will not be able to complete iApp configuration.
    3. Every virtual server you select here must have a default pool attached to it.
    4. If you choose more than one virtual server here, they must all be the same type, either all HTTP or all HTTPS. To use virtual servers of different types, create an iApp for each type.
  16. Click Finished.

  17. In the Cloud Services portal, click Done.

    That’s it, you’re done. DeviceID+ has now been deployed on your web application.

Testing DeviceID+ Deployment

After onboarding your application with DeviceID+, it is a good idea to test that the deployment was successful.

Follow these steps to check that deployment was successful:

  1. For every web page that received the DeviceID+ JavaScript injection, open the page in a web browser.
  2. Check that the page source contains the DeviceID+ JavaScript.
  3. Check that the page contains the _imp_apg_r cookie.