API workflow principles

Treat each API integration as an explicit workflow with a known account, scope and direction of data.

Use scoped credentials

Create a separate key for each connected service. Grant only the resources and actions that workflow needs, and rotate or revoke the key without affecting other integrations.

Prefer stable identifiers

Use internal attribute names and product identifiers in integrations. Display labels can then evolve without breaking mappings.

Make retries safe

Plan imports and publications so repeating a request does not create duplicate products or destination records. Record the relationship between the PIM product and the external identifier.

Use segments as contracts

A segment gives both the integration and the catalog team a visible definition of which products are in scope.