Getting started

Terminology

A resource is an object with a type, associated data and relationships to other resources (example: product).

A collection is a set of resources of the same type (example: products).

A namespace is a group of related collections (example: localization).

A sub-namespace is a namespace nested under a parent namespace.

A sub-collection is a collection nested under a resource (example: product items).

An action is an operation that can be performed on a collection or a resource (example: approve request).

connect-openapi-client runs on python 3.8 or later.

connect-openapi-client is a small python package that can be installed from the pypi.org repository.

$ pip install connect-openapi-client

To use connect-openapi-client first of all you have to create an instance of the ConnectClient object:

from connect.client import ConnectClient

client = ConnectClient('ApiKey SU-000-000-000:xxxxxxxxxxxxxxxx')