Legacy

Status: Deprecated — Legacy Java SDK is provided for backward compatibility and is maintenance-only.

Java SDK — Legacy

Legacy Java SDK for BSG API. Provided for backward compatibility with earlier Java integrations and legacy API workflows.

Status

• Version: Legacy

• Status: Deprecated

• Repository: https://github.com/bsgworld/java-rest-api

• Support level: Maintenance only

Overview

The Legacy Java SDK provides a Java client wrapper for interacting with BSG messaging APIs.

It was designed for earlier API versions and legacy authentication models. This SDK is intended only for existing integrations.

New projects should use newer SDK versions where available.

Installation

1

Clone the repository

git clone https://github.com/bsgworld/java-rest-api.git

2

Build the project

Build the project using Maven or Gradle (depending on repository configuration).

Example with Maven:

Maven

mvn clean install

3

Include the artifact

Then include the built artifact in your project dependencies.

Requirements

• Java 8+ (recommended Java 11+)

• Maven or Gradle

• Network access to BSG API endpoints

• Legacy API credentials

Exact dependency versions are defined in the repository configuration.

Authentication

Legacy SDK uses legacy authentication parameters supported by earlier BSG API versions.

Credential format and client initialization differ from newer SDK releases.

Refer to repository README and example code for exact initialization details.

Usage

Basic usage pattern:

Example.java

import com.bsg.Client;

public class Example {
    public static void main(String[] args) throws Exception {

        Client client = new Client(
            "YOUR_LOGIN",
            "YOUR_PASSWORD"
        );

        Object response = client.sendSms(
            "1234567890",
            "Test message"
        );

        System.out.println(response);
    }
}

Available methods depend on the SDK implementation version.

Important Notes

• Targets legacy API endpoints

• Uses legacy authentication model

• Method signatures differ from modern SDKs

• No new features are added to this SDK

Limitations

Legacy SDK may not support:

• API v2 endpoints

• Modern authentication schemes

• New verification services

• Extended response formats

Migration Recommendation

For new Java integrations, use a newer SDK version when available.

Refer to updated SDK pages in this documentation.

Links

• GitHub repository: https://github.com/bsgworld/java-rest-api

• API Reference: {{add_api_reference_link}}

• Support: contact your account manager