Documentation – Swift

V4: Setup of Swift SDK

Mon, 01 Jan 0001 00:00:00 +0000

The Aspose.BarCode Cloud SDK for Swift allows you to easily integrate barcode generation and recognition functionality into your Swift applications. This guide will walk you through the setup process using the GitHub repository and Swift Package Manager or CocoaPods .

Prerequisites

Swift 6.0 or later, iOS 15.0 or later, macOS 12.0 or later, tvOS 15.0 or later, watchOS 8.0 or later
An Aspose Cloud account. Sign up for free on Aspose.Cloud to obtain your Client Id and Client Secret. More information about it on Quickstart page.

Installing the SDK

You can install the Aspose.BarCode Cloud SDK via Swift Package Manager or CocoaPods:

The AsposeBarcodeCloud pod is not published to the CocoaPods trunk repository yet, so use Swift Package Manager until it becomes available. For CocoaPods, add the pod to your Podfile:

pod 'AsposeBarcodeCloud', '~> 26.9'

For Swift Package Manager, add the package dependency to Package.swift:

.package(url: "https://github.com/aspose-barcode-cloud/Aspose.BarCode-Cloud-SDK-for-Swift.git", from: "26.9.0")

Setting Up the Configuration

The AsposeBarcodeCloudClient class is essential for setting up the SDK. It manages your API credentials, base URLs, and other settings.

Basic Configuration

First, import the required namespaces:

import AsposeBarcodeCloud

Then, set up the configuration:

let client = AsposeBarcodeCloudClient(
    clientId: "<Your-Client-Id>",
    clientSecret: "<Your-Client-Secret>"
)

This basic setup will use the default values for API base url, token url and other options which are optimized for general use.

Using the SDK

Once configured, pass the configuration object to initialize API clients. Here’s an example:

let imageData = try await GenerateAPI.generate(
    barcodeType: .qr,
    data: "Aspose.BarCode Cloud",
    barcodeImageParams: BarcodeImageParams(imageFormat: .png),
    apiConfiguration: client.apiConfiguration
)

Now you can call SDK functions.

Conclusion

This documentation has provided the necessary steps to configure and initialize the Aspose.BarCode Cloud SDK for Swift. Refer to the other sections of the Developer Guide for more detailed usage examples.

V4: Authorization in Swift SDK

Mon, 01 Jan 0001 00:00:00 +0000

This documentation provides an overview of how to configure and authorize requests to the Aspose Barcode Cloud API using JWT and external authorization methods. It covers key code examples and settings needed to enable secure and authorized API requests.

Note: For manage authorization you should have a Client Id and Client Secret. How to get it described in Quick Start Section

Overview

Aspose Barcode Cloud API supports two main authorization methods:

JWT (JSON Web Token) - Allows token-based authentication where tokens are obtained using Client Id and Client Secret.
External Authorization - Permits manual setting of JWT tokens for custom authorization.

JWT Authorization

When using JWT, the API classes automatically obtains a token and includes it in each API request.

Setting Up JWT Authorization

To set up JWT authorization, specify the clientId and clientSecret:

let client = AsposeBarcodeCloudClient(
    clientId: "<Your-Client-Id>",
    clientSecret: "<Your-Client-Secret>"
)

let imageData = try await GenerateAPI.generate(
    barcodeType: .qr,
    data: "Aspose.BarCode Cloud",
    barcodeImageParams: BarcodeImageParams(imageFormat: .png),
    apiConfiguration: client.apiConfiguration
)

Upon setup, the internal SDK methods handles token generation and token refresh:

The RequestToken method requests a token using clientId and clientSecret.
The token is added to the Authorization header for each request.

External Authorization

External authorization allows you to manually manage tokens. Assign your JWT token directly to accessToken and leave clientId and clientSecret blank.

Setting Up External Authorization

Example configuration with External Authorization:

let client = AsposeBarcodeCloudClient(accessToken: "<Your-External-Jwt-Token>")

let response = try await ScanAPI.scan(
    fileUrl: "https://products.aspose.app/barcode/scan/img/how-to/scan/step2.png",
    apiConfiguration: client.apiConfiguration
)

In this mode, the API sends the provided JWT in the Authorization header without attempting to generate or refresh the token.

How to Fetch a Token without SDK Internal Methods

To fetch a new token, send a POST request to https://id.aspose.cloud/connect/token with the application/x-www-form-urlencoded content type. In the request body, specify the following parameters:

grant_type=client_credentials
client_id=<Your-Client-Id>
client_secret=<Your-Client-Secret>

A Code example for fetching token:

import Foundation
#if canImport(FoundationNetworking)
    import FoundationNetworking
#endif

struct TokenResponse: Decodable {
    let accessToken: String

    enum CodingKeys: String, CodingKey {
        case accessToken = "access_token"
    }
}

let clientId = "Client Id from https://dashboard.aspose.cloud/applications"
let clientSecret = "Client Secret from https://dashboard.aspose.cloud/applications"
let tokenURL = URL(string: "https://id.aspose.cloud/connect/token")!

var form = URLComponents()
form.queryItems = [
    URLQueryItem(name: "grant_type", value: "client_credentials"),
    URLQueryItem(name: "client_id", value: clientId),
    URLQueryItem(name: "client_secret", value: clientSecret),
]

var request = URLRequest(url: tokenURL)
request.httpMethod = "POST"
request.setValue("application/x-www-form-urlencoded", forHTTPHeaderField: "Content-Type")
request.httpBody = form.percentEncodedQuery?.data(using: .utf8)

let (data, response) = try await URLSession.shared.data(for: request)

guard let httpResponse = response as? HTTPURLResponse,
      200 ..< 300 ~= httpResponse.statusCode
else {
    throw NSError(domain: "AsposeBarcodeCloud", code: 1)
}

let token = try JSONDecoder().decode(TokenResponse.self, from: data)
print(token.accessToken)

Conclusion

Configuring authorization in the Aspose.BarCode.Cloud SDK for Swift allows secure, authenticated access to barcode-related functionalities. Choose JWT authorization with client id and secret for automatic token management or external authorization for custom token handling.

With these examples and explanations, you should be able to set up authorization for the Aspose.BarCode.Cloud SDK for Swift.

V4: Generate barcodes

Mon, 01 Jan 0001 00:00:00 +0000

V4: Read barcodes

Mon, 01 Jan 0001 00:00:00 +0000