Developer Guide

Integrating Barcodesoft with Workday Extend

Leverage Workday Orchestrations and Custom UI components to generate dynamic barcodes directly within your Workday apps.

Prerequisites

Upon completing your order, you will receive an automated email containing your User_id, Secret, and Scope[cite: 3, 4]. These credentials are required to authenticate with the https://www.barcodesoft.com/api/auth/token endpoint[cite: 3, 4].

Integration Architecture

1. Orchestration

A Workday Orchestration manages the OAuth 2.0 token handshake and the subsequent REST call to the barcode service[cite: 3, 4].

2. Secure Storage

Tokens are cached within the app session to optimize performance and respect API rate limits[cite: 3, 4].

3. Component UI

The generated SVG or PNG barcode is bound to an Image Component in the Workday App UI[cite: 3, 4].

Step-by-Step Implementation

1 Secure the Bearer Token

Configure an External Service in Workday Extend and use the following parameters to obtain a token[cite: 3, 4]:

POST https://www.barcodesoft.com/api/auth/token
Content-Type: application/x-www-form-urlencoded

grant_type=client_credentials
&client_id=[YOUR_USER_ID]
&client_secret=[YOUR_SECRET]
&scope=[YOUR_SCOPE]
2 Dynamic Barcode Endpoint Call

In your Orchestration, build the URL dynamically. For example, to generate a GS1-128 linear barcode[cite: 3, 4]:

Parameter Value Purpose
data(02)12345...The payload to encode[cite: 3, 4]
width3inPhysical width[cite: 3, 4]
imageformatsvgVector format (recommended)[cite: 3, 4]
dpi300Print resolution[cite: 3, 4]
3 UI Presentation (PMD)

Map the image URL returned by your Orchestration to an image widget in your Workday Extend page code:

{
  "type": "image",
  "label": "Asset Tag Barcode",
  "sourceUrl": "${orchestrationResponse.barcodeUrl}"
}

Get Your Integration Credentials

Order a subscription to unlock full access to the Cloud Barcode API. Credentials (User_id, Secret, Scope) are delivered immediately via email[cite: 3, 4].

Cloud barcode API order
Supports GS1-128 & QR Code[cite: 3, 4] PNG, SVG, WebP Formats[cite: 3, 4] OAuth 2.0 Secure[cite: 3, 4]

Optimization Tips

  • Use SVG for Zoom: SVG is natively supported in Workday Extend and provides the best experience for mobile scanning[cite: 3, 4].
  • Token Expiry: Implement a "Try-Catch" block in your Orchestration. If the barcode call returns 401, refresh the token[cite: 3, 4].
  • URL Encoding: Encode all parameters (especially the data field) to ensure special characters like () don't break the REST call[cite: 3, 4].

Technical Support

Our team provides 1-on-1 assistance for Workday Studio and Extend integrations.

Contact Support