Currency

Version 1.0

The Connector Entity is a key element in our system, facilitating seamless connections with external platforms like Shopify and Amazon. It holds vital information such as Connector Name, Type, Authentication Details, and URLs, ensuring smooth data exchange and integration. Connectors empower our platform to interact effectively with diverse e-commerce systems, enhancing flexibility and global reach.

# Endpoints
GET
/v1/connectors# Retrieve all connectors
GET
/v1/connectors/1# Retrieve a single connector

Connector Entity

  • Name
    id
    Type
    string
    Required
    Description

    The unique identifier for the connector, serving as the primary key.

  • Name
    enabled
    Type
    boolean
    Required
    Description

    Indicates whether the connector is currently enabled or disabled.

  • Name
    name
    Type
    string
    Required
    Description

    The name of the connector, providing a descriptive identification.

  • Name
    type
    Type
    string
    Required
    Description

    The type of connector, categorizing it as an online store, advertising platform, or marketplace.

    Online Store
    Advertising
    Marketplace
  • Name
    config
    Type
    json
    Required
    Description

    Configuration parameters for the connector, stored as a JSON object.

  • Name
    created_at
    Type
    timestamp
    Description

    The timestamp indicating when the connector was created, formatted in ISO 8601.

  • Name
    updated_at
    Type
    timestamp
    Description

    The timestamp indicating when the connector was last updated, formatted in ISO 8601.

  • Name
    created_by
    Type
    foreignId
    Description

    The foreign ID indicating the user who created the connector.

  • Name
    updated_by
    Type
    foreignId
    Description

    The foreign ID indicating the user who last updated the connector.

The Connector resource

JSON
{
  "id": "987654321",
  "enabled": true,
  "name": "Shopify Connector",
  "type": "Online Store",
  "config": {
    "api_key": "required",
    "api_secret": "required",
  },
  "created_at": "2024-01-19T12:15:00Z",
  "updated_at": "2024-01-19T14:45:00Z",
  "created_by": "789012345",
  "updated_by": "123456789"
}

Retrieve all connectors

This endpoint allows you to retrieve all connectors.

Examples

Retrieve all connectors

GET
/v1/connectors
curl --request GET \
  --url https://api.qooly.io/v1/connectors

Retrieve all connectors

GET
/v1/connectors
curl --request GET \
  --url https://api.qooly.io/v1/connectors
JSON
[
  {
    "id": "987654321",
    "enabled": true,
    "name": "Shopify Connector",
    "type": "online store",
    "config": {
      "api_key": "your-api-key",
      "store_url": "https://shopify-store.com",
      "credentials": {
        "username": "your-username",
        "password": "your-password"
      }
    },
    "created_at": "2024-01-19T12:15:00Z",
    "updated_at": "2024-01-19T14:45:00Z",
    "created_by": "789012345",
    "updated_by": "123456789"
  },
  {
    "id": "876543210",
    "enabled": false,
    "name": "Amazon Connector",
    "type": "marketplace",
    "config": {
      "api_key": "your-api-key",
      "seller_id": "your-seller-id",
      "region": "your-region"
    },
    "created_at": "2024-01-19T13:30:00Z",
    "updated_at": "2024-01-19T15:20:00Z",
    "created_by": "789012345",
    "updated_by": "123456789"
  }
]

Retrieve a single connector

This endpoint allows you to retrieve details about a specific connector.

Required Parameters

  • Name
    id
    Type
    string
    Required
    Description

Examples

Retrieve a single connector

GET
/v1/connectors/987654321
curl --request GET \
  --url https://api.qooly.io/v1/connectors/987654321

Retrieve a single connector

GET
/v1/connectors/987654321
curl --request GET \
  --url https://api.qooly.io/v1/connectors/987654321
JSON
{
  "id": "987654321",
  "enabled": true,
  "name": "Shopify Connector",
  "type": "online store",
  "config": {
    "api_key": "your-api-key",
    "store_url": "https://shopify-store.com",
    "credentials": {
      "username": "your-username",
      "password": "your-password"
    }
  },
  "created_at": "2024-01-19T12:15:00Z",
  "updated_at": "2024-01-19T14:45:00Z",
  "created_by": "789012345",
  "updated_by": "123456789"
}