Show Menu
TOPICS×

Integration overview and prerequisites

This information shows you how to create an Adobe I/O and a Places integration.

Prerequisites for user access

Verify with your organization's System administrator that the following tasks have been completed:
  • Places Core Service appears in your organization's admin console.
  • You have been added to the organization.
  • You have been added as a User to Places Core Service in your organization.
    For more information, see Add a user or a developer to your Location Service and Experience Platform Launch profiles in Frequently asked questions .
  • You have been added as a Developer to Places Core Service in your organization.
    For more information on adding developers see Add a user or a developer to your Location Service and Experience Platform Launch profiles in Frequently asked questions .
    For more information about the developer role, see Manage developers .

REST API requests

Each request to the Places REST API requires the following items:
  • An organization ID
  • An API key
  • A bearer token
An integration with Adobe I/O provides these items and a way to request the bearer token by using a JSON Web Token (JWT).
If you cannot log in to the Adobe I/O console, or if Experience Platform Location Service is not an option on the Create Integrations page , see Organization requirements in Web services API overview .

Create a Places integration

To create an Places integration, complete the following tasks:

Generate a public and private key pair

To create a Places integration, you need a public and a private key pair. These pairs can be purchased, or you can generate your own self-signed keys.
To generate your own self-signed keys:
  1. In a terminal window, copy and paste each of the following lines and press Enter after pasting each line:
       mkdir keys
       cd keys
       openssl req -x509 -sha256 -nodes -days 365 -newkey rsa:2048 -keyout places_integration_test_private.key -out    places_integration_test_public.crt
    
    
    We recommend that you name your keys for easy reference and store them in a folder. If you create multiple integrations, you can easily identify and manage which keys belong to which integration.
  2. Type the information that is requested by OpenSSL:
    Country Name (2 letter code:  // Example: US
    State or Province Name (full name):  // Example: California
    Locality Name (eg, city):  // Example: San Jose
    Organization Name (eg, company):  // Example: Places
    Organizational Unit Name (eg, section):  // Example: Engineering
    Common Name (eg, fully qualified host name):  // Example: places.com
    Email Address:  // Example:  poi@places.com
    
    
    For more information about OpenSSL, see OpenSSL .
    The information that you provide is incorporated into the keys.
  3. Navigate to the directory where the .key and .crt files are located.
    For example, in iOS, go to Macintosh HD > users > (your user name) > Keys .
The following video guides you through the process of generating the key pair:

Create a Places integration in the Adobe I/O console

To create a Places integration:
  1. Go to https://console.adobe.io and sign in with your Adobe ID.
  2. In the Quick Start section, click on Create integration .
  3. Select Access an API and click Continue .
    Access an API is the default location.
  4. If you have access to more than one Experience Cloud organization, select the organization from the drop-down list on the top right.
  5. Under Experience Cloud , select Places as the Adobe service to which you want to integrate and click Continue .
  6. Select New integration and click Continue .
  7. On the Create a new integration screen, enter a name and description.
  8. Drag and drop your xxxx_public.crt file, that you created above, to the Public keys certificates drop zone.
  9. Select a product profile.
    If you are unsure of which profile to select, contact your system administrator.
  10. At the bottom of the page, click Create integration .
  11. After a few seconds, in the Integration created screen, verify that the following message appears:
    Your integration has been created.
  12. The integration details page appears with the name of the integration at the top.
    The Overview tab appears by default and displays the API key, your organization ID, the technical account ID, and other details about your integrations.

Record the organization ID and the API key

  1. On the integration details page, click the Services tab and confirm that Places is displayed under Configured Services .
  2. On the Overview tab, locate and record the API Key (Client ID) and the Organization ID.
    These IDs are needed for each Places REST API request.

Generate a JWT token

On the integration details page, click the JWT tab so that you can test your integration by generating a JWT and providing the exchange URL.
To generate a JWT token:
  1. In a text editor, open your private.key file created that you created above.
  2. On the JWT tab, copy the contents of the key and paste it in the Paste private key field.
  3. Click Generate JWT .
  4. In the Sample CURL command section, click Copy and paste the contents in your command prompt or terminal window.
  5. Run the command by pressing Enter on your keyboard.
  6. Locate the "token_type": "bearer" and the "access_token" value.
    The value of the bearer access token is what you will use in your Places API requests.
Adobe access tokens are valid only for 24 hours, so save the sample CURL command (step 5). If the access token is no longer valid, you need to regenerate the token.