Channel

Version 1.0

The Connection Entity plays a pivotal role in our system, serving as a bridge that enables seamless integration with external platforms such as Shopify and Amazon. It encompasses essential details like Connection Name, Type, Authentication Credentials, and URLs. Connections are instrumental in fostering smooth data exchange, allowing our platform to interact seamlessly with a variety of e-commerce systems. This capability enhances flexibility and expands our global reach.

# Endpoints
POST
/v1/connections# Create a single connection
GET
/v1/connections# Retrieve all connections
GET
/v1/connections/123456789# Retrieve a single connection
PATCH
/v1/connections/123456789# Update a single connection
DELETE
/v1/connections/123456789# Delete a single connection

Connection Entity

  • Name
    id
    Type
    string
    Required
    Description

    Every connection is assigned a unique identifier - an unsigned 64-bit integer known as the Connection ID. This specific number is exclusive and distinct across the entire Qooly platform, ensuring unparalleled uniqueness for each connection.

  • Name
    connector_id
    Type
    foreignId
    Required
    Description

    This serves as a unique, distinct identifier for the connector associated with the connection. It references the Connector ID in Qooly's system.

  • Name
    status
    Type
    varchar(16)
    Default: DRAFT
    Description

    This property indicates the status of the connection.

    DraftThe connection is in draft mode. This is the default status for new connections.
    EnabledThe connection is enabled. This means that the connection is available for use.
    DisabledThe connection is disabled. This means that the connection is not available for use.
    ArchivedThe connection is archived for future reference.
  • Name
    code
    Type
    varchar(64)
    Description

    This property indicates the code of the connection.

  • Name
    name
    Type
    varchar(255)
    Required
    Description

    This property indicates the name of the connection.

  • Name
    auth
    Type
    varchar(255)
    Description

    This property indicates the authentication details for the connection.

  • Name
    config
    Type
    json
    Description

    This property stores configuration details for the connection in JSON format.

The Connection resource

JSON
{
  "id": "123456789",
  "connector_id": "987654321",
  "status": "DRAFT",
  "code": "CONN123",
  "name": "Sample Connection",
  "auth": "BearerToken123",
  "config": {
    "property1": "value1",
    "property2": "value2"
  }
}

Create a single connection

This endpoint allows you to create a single connection.

Required Fields

  • Name
    name
    Type
    varchar(255)
    Required
    Description
  • Name
    code
    Type
    varchar(64)
    Required
    Description
  • Name
    status
    Type
    varchar(16)
    Default: DRAFT
    Description
    DraftThe connection is in draft mode. This is the default status for new connections.
    EnabledThe connection is enabled. This means that the connection is available for use.
    DisabledThe connection is disabled. This means that the connection is not available for use.
    ArchivedThe connection is archived for future reference.
  • Name
    auth
    Type
    varchar(255)
    Description
  • Name
    config
    Type
    json
    Description

Examples

Create a single connection

POST
/v1/connections
curl --request POST \
  --url https://api.qooly.io/v1/connections \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "Sample Connection",
    "code": "CONN123",
    "status": "DRAFT",
    "auth": "BearerToken123",
    "config": {
      "property1": "value1",
      "property2": "value2"
    }
  }'

Create a single connection

POST
/v1/connections
curl --request POST \
  --url https://api.qooly.io/v1/connections \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "Sample Connection",
    "code": "CONN456",
    "status": "DRAFT"
  }'

Create a single connection

POST
/v1/connections
curl --request POST \
  --url https://api.qooly.io/v1/connections \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "Sample Connection",
    "code": "CONN123",
    "status": "DRAFT",
    "auth": "BearerToken123",
    "config": {
      "property1": "value1",
      "property2": "value2"
    }
  }'
JSON
{
  "id": "987654321",
  "status": "DRAFT",
  "name": "Sample Connection",
  "code": "CONN123",
  "auth": "BearerToken123",
  "config": {
    "property1": "value1",
    "property2": "value2"
  },
  "created_at": "2024-01-08T09:45:00Z",
  "created_by": "789012345",
}

Retrieve all connections

This endpoint allows you to retrieve all connections.

Examples

Retrieve all connections

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

Retrieve all connections

GET
/v1/connections
curl --request GET \
  --url https://api.qooly.io/v1/connections
JSON
[
  {
    "id": "987654321",
    "status": "DRAFT",
    "name": "Sample Connection 1",
    "code": "CONN123",
    "auth": "BearerToken123",
    "config": {
      "property1": "value1",
      "property2": "value2"
    },
    "created_at": "2024-01-08T09:45:00Z",
    "created_by": "789012345",
  },
  {
    "id": "876543210",
    "status": "ENABLED",
    "name": "Sample Connection 2",
    "code": "CONN456",
    "auth": "BearerToken456",
    "config": {
      "property1": "value1",
      "property2": "value2"
    },
    "created_at": "2024-01-09T11:30:00Z",
    "created_by": "123456789",
  }
]

Retrieve a single connection

This endpoint allows you to retrieve a single connection.

Required Parameters

  • Name
    id
    Type
    string
    Required
    Description

Examples

Retrieve a single connection

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

Retrieve a single connection

GET
/v1/connections/987654321
curl --request GET \
  --url https://api.qooly.io/v1/connections/987654321
JSON
{
  "id": "987654321",
  "status": "DRAFT",
  "connector_id": "123456789",
  "name": "Sample Connection",
  "code": "CONN123",
  "auth": "BearerToken123",
  "config": {
    "property1": "value1",
    "property2": "value2"
  },
  "created_at": "2024-01-08T09:45:00Z",
  "created_by": "789012345",
}

Update a single connection

This endpoint allows you to update a single connection.

Required Parameters

  • Name
    id
    Type
    string
    Required
    Description

Examples

Update a single connection

PATCH
/v1/connections/987654321
curl --request PATCH \
  --url https://api.qooly.io/v1/connections/987654321 \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "New Connection Name",
    "auth": "UpdatedBearerToken",
    "config": {
      "property1": "newValue1",
      "property2": "newValue2"
    }
  }'

Update a single connection

PATCH
/v1/connections/987654321
curl --request PATCH \
  --url https://api.qooly.io/v1/connections/987654321 \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "New Connection Name",
    "auth": "UpdatedBearerToken"
  }'
JSON
{
  "id": "987654321",
  "status": "DRAFT",
  "connector_id": "123456789",
  "name": "New Connection Name",
  "code": "CONN123",
  "auth": "UpdatedBearerToken",
  "config": {
    "property1": "newValue1",
    "property2": "newValue2"
  },
  "created_at": "2024-01-08T09:45:00Z",
  "created_by": "789012345",
}

Delete a single connection

This endpoint allows you to delete a single connection.

Required Parameters

  • Name
    id
    Type
    string
    Required
    Description

Examples

Delete a single connection

DELETE
/v1/connections/987654321
curl --request DELETE \
  --url https://api.qooly.io/v1/connections/987654321

Delete a single connection

DELETE
/v1/connections/987654321
curl --request DELETE \
  --url https://api.qooly.io/v1/connections/987654321
JSON
{}