API Connector

The API Connector application works in three simple steps.

1. API Connector queries the external API of your choice (OpenAI, Bazaarvoice, your PIM, etc.).
2. The retrieved data is automatically stored in DataStorage, structured, and associated with your URLs.
3. You reuse this data in SEO Recommendations to enrich your pages (FAQs, customer reviews, summaries, AI-generated content, etc.).

In summary: a single configuration → always up-to-date data → automated SEO recommendations.

How do I configure an API connector?

Step 1 - Create a secret

Before configuring an API connector, you must store your API keys in the " Secrets " section. Secrets allow you to secure your authentication keys without exposing them in plain text.

1. Access the Secrets module from the first step of the API connector configuration.
2. Click on the " Add a new secret " link.
3. Then click on the " Add a new secret " button.
4. Enter the name of the secret: use a short and explicit name (e.g., OpenAIKey, DeepLToken, BazaarvoiceAuth).
5. Enter the secret value: copy and paste your API key provided by the external service.
6. Click Create

🔒 Secrets are encrypted and never displayed in plain text. They will then be called in your API headers in the form Authorization: Bearer SecretName.

Step 2 - Create a new connector

1. Access the API Connector application from your EdgeSEO console.
2. Click the New Connector button
3. Enter the name of the connector: choose a short, descriptive name to easily identify the connector (e.g., "Product reviews," "Title translation," "Generated FAQ").
4. Add a description: indicate the purpose of the connector to make it easier for your team to understand (e.g., "Retrieves customer reviews from Bazaarvoice to display them on product pages").
5. Click Next

Step 3 - Define dynamic variables (optional)

This step is optional. It allows you to retrieve elements from the page (text, HTML attributes, HTML code) to send them in your API request.

The operation is identical to variables in the SEO Recommendation application.

For example, you can extract the content of an H1 tag, a specific CSS class, or a data attribute to use in your API call.

1. Click Add Variable if you want to create one.
2. Enter the name of the variable (e.g., "mavariable")
3. Specify the CSS selector (e.g., "h1.classCss")
4. Select the type of element to extract (Text, HTML, etc.)
5. Click Next

Step 4 - Define the trigger target

This step determines where and when the API request will be executed on your site.

The functionality is identical to the targets in the SEO Recommendation application. You can target specific URLs, page types, or use regular expressions.

1. Click on Create my first target
2. Configure your target according to your needs (URL equals, contains, regular expression, etc.)

Step 5 - Configure the API request

This is the central step where you configure the call to your external API.

1. Choose the HTTP method for your request (POST, GET, etc.).
2. Configure the endpoint: enter the full URL of the API to query (e.g., https://api.openai.com/v1/chat/completions)
3. Define headers : add the necessary headers for your request
   • Click on the field to add a header
   • Header name (e.g., Content-Type, Authorization)
   • Header value (e.g., application/json, Bearer SecretName)
   • To use a secret, reference it directly in the value (e.g., Bearer OpenAIKey).
4. Define the body (body of the request) : enter the JSON content of your request
   • You can use the dynamic variables created previously by clicking in the field.
   • Exemple : {"model":"gpt-4o-mini","messages":[{"role":"user","content":"Reformule ce titre : {{h1}} pour black friday"}]}
5. Define the TTL (time to live) :
   • Select a duration in seconds during which the data will be considered valid before a new request is made.
   • Adjust this value according to how often your data is updated.
6. Enter a test value and click the Test button to verify that the query works.
7. Map the response : associate API response fields with custom keys to facilitate their use in DataStorage
   • Custom key (e.g., "faq," "model")
   • Select the API response path by clicking in the field.
8. Click on save

The received data is automatically stored in DataStorage and associated with the URL where the request was triggered. A dataset is automatically created for each connector.

Step 6 - Use the data in SEO Recommendations

Once your connector is configured and active, the data is available in DataStorage. You can reuse it in your SEO Recommendation recipes.

1. Access the SEO Recommendation application
2. Create or edit a recipe
3. Select the variables you want to use according to the mapping you have defined.
   • Example: if you have mapped the variable "faq," use this variable directly.

The data can now be used in your SEO recommendations to automatically enrich your pages.

‍