Skip to content

commercetools/commercetools-dev-training-connector

Repository files navigation

commercetools logo
A Connector to demonstrate commercetools Connect in Developer courses

About & Scope

This Connector is to be used in developer training sessions only. It contains three applications:

  1. a service app that validates if the customer is allowed to place the order
  2. an event app that sends emails to the customers - only order confirmation emails yet
  3. a job app that manages the new arrivals category, adding new products and removing the products older than 30 days

Prerequisite

  • commercetools Composable Commerce account
  • API Credentials to your project

To create an API Client in the Merchant Center, go to Settings > Developer settings > Create new API client. Take note of the following:

  • CTP_PROJECT_KEY
  • CTP_CLIENT_ID
  • CTP_CLIENT_SECRET

How to Install

Deploy this demo Connector into any project to learn and experience how commercetools Connect makes integrations quick and easy. Follow the steps from the commercetools connect deployment documentation.

This Connector contains three applications, each of a different type.

Validate customer service app

It allows you to validate if the customer is allowed to place the order by checking a custom field on the customer.

Configurations:

  1. API credentials to your project
  2. Custom type with a boolean field to block the user

Order confirmation email event app

This event type app is triggered by the notification that is generated whenever an order is placed. It sends an order confirmation email. It's working with Sendgrid (Twilio) but can easily be updated to work with other providers.

Configurations:

  1. API credentials
  2. The API key used to communicate with the email provider
  3. Sender's email address
  4. Id of order confirmation email template created in the email service provider

Manage new-arrivals category job app

This job runs every 10 minutes and manages the products in the new arrivals category.

Configurations:

  1. Category key for new arrivals
  2. API credentials

How to Uninstall

In order to uninstall the connector, either send a DELETE using API or simply uninstall it from the Merchant Center.