b2c-webservices

Web Services Skill

This skill guides you through implementing web service integrations in B2C Commerce using the Service Framework.

Overview

The Service Framework provides a structured way to call external services with:

Feature	Description
Configuration	Service settings managed in Business Manager
Rate Limiting	Automatic throttling to protect external systems
Circuit Breaker	Automatic failure handling to prevent cascade failures
Logging	Communication logging with sensitive data filtering
Mocking	Test services without external calls

Service Types

Type	Use Case	Protocol
HTTP	REST APIs, webhooks	HTTP/HTTPS
HTTPForm	Form submissions	HTTP/HTTPS with form encoding
FTP	File transfers (deprecated)	FTP
SFTP	Secure file transfers	SFTP
SOAP	SOAP web services	HTTP/HTTPS with SOAP
GENERIC	Custom protocols	Any

Service Framework Components

Business Manager Configuration

Services are configured in Administration > Operations > Services:

1. Service Configuration - General settings (enabled, logging, callbacks)
2. Service Profile - Rate limiting and circuit breaker settings
3. Service Credential - URL and authentication credentials

Script Components

Component	Purpose
LocalServiceRegistry	Creates service instances
ServiceCallback	Defines request/response handling
Service	Base service with common methods
Result	Response object with status and data

Basic Pattern

'use strict';

var LocalServiceRegistry = require('dw/svc/LocalServiceRegistry');

var myService = LocalServiceRegistry.createService('my.service.id', {
    /**
     * Configure the request before it is sent
     * @param {dw.svc.HTTPService} svc - The service instance
     * @param {Object} params - Parameters passed to service.call()
     * @returns {string} Request body
     */
    createRequest: function (svc, params) {
        svc.setRequestMethod('POST');
        svc.addHeader('Content-Type', 'application/json');
        return JSON.stringify(params);
    },

    /**
     * Parse the response after a successful call
     * @param {dw.svc.HTTPService} svc - The service instance
     * @param {dw.net.HTTPClient} client - The HTTP client with response
     * @returns {Object} Parsed response
     */
    parseResponse: function (svc, client) {
        return JSON.parse(client.text);
    },

    /**
     * Filter sensitive data from logs (required for production)
     * @param {string} msg - The message to filter
     * @returns {string} Filtered message
     */
    filterLogMessage: function (msg) {
        return msg.replace(/("api_key"\s*:\s*")[^"]+"/g, '$1***"');
    }
});

// Call the service
var result = myService.call({ key: 'value' });

if (result.ok) {
    var data = result.object;
} else {
    var error = result.errorMessage;
}