Using the data ingestion API

Use the data ingestion API to create and manage product data for your ecommerce catalog. Data includes products, product attribute metadata, prices books, and prices.

Endpoints

Send all Data Ingestion requests to this endpoint: https://commerce.adobe.io/api

Authentication

To interact with the Data Ingestion API, the consumer must authenticate by generating a JWT token signed with the public API key from your Commerce account at https://account.magento.com.

For instructions on generating the public API key, see Generate the production and sandbox keys

Generate JWT token

Use the following java code to generate a JWT token signed with the private key associated with your public API key.

JwtGenerator.java

Copy
import io.jsonwebtoken.Jwts;
import io.jsonwebtoken.SignatureAlgorithm;
import java.security.PrivateKey;
import java.time.Instant;
import java.time.temporal.ChronoUnit;
import java.util.Date;

public class JwtGenerator {

    public String generateJwt(PrivateKey privateKey) {

        Instant now = Instant.now();

        return Jwts.builder()
                   .setIssuedAt(Date.from(now))
                   .setExpiration(Date.from(now.plus(5L, ChronoUnit.MINUTES)))
                   .signWith(privateKey, SignatureAlgorithm.RS256)
                   .compact();
    }
}
Copied to your clipboard
import io.jsonwebtoken.Jwts;
import io.jsonwebtoken.SignatureAlgorithm;
import java.security.PrivateKey;
import java.time.Instant;
import java.time.temporal.ChronoUnit;
import java.util.Date;

public class JwtGenerator {

    public String generateJwt(PrivateKey privateKey) {

        Instant now = Instant.now();

        return Jwts.builder()
                   .setIssuedAt(Date.from(now))
                   .setExpiration(Date.from(now.plus(5L, ChronoUnit.MINUTES)))
                   .signWith(privateKey, SignatureAlgorithm.RS256)
                   .compact();
    }
}

Path parameters

Include the following path parameter in each API request.

Header parameters

Include the following headers in REST API requests.

Request template

Use the following template to submit requests using cURL.

Copy
curl --request POST \
  --url https://commerce.adobe.io/api/v1/<API_ENDPOINT>/<DATA_SPACE_ID> \
  --header 'Content-Type:  application/json' \
  --header 'x-api-key: <API_KEY>' \
  --header 'x-gw-signature: <JWT_TOKEN>' \
  --data '<API_PAYLOAD>'
Copied to your clipboard
curl --request POST \
  --url https://commerce.adobe.io/api/v1/<API_ENDPOINT>/<DATA_SPACE_ID> \
  --header 'Content-Type:  application/json' \
  --header 'x-api-key: <API_KEY>' \
  --header 'x-gw-signature: <JWT_TOKEN>' \
  --data '<API_PAYLOAD>'

For sample requests, see the tutorial.

Last updated 2/14/2025

Was this helpful?

Yes

No