Integration Documentation

Welcome to the official integration documentation for the SportyWallet Worker service.

This guide is intended for external partners who need to read card identifiers and write credits to cards through the Worker running on a host machine.

Integration Scope
Authentication
Getting Started
Quick Test Flow
Testing Tools
Worker download by environments:
Support

Integration Scope

The only integration entry point is the local HTTP API exposed by the Worker service.

Available operations:

Check service availability with GET /ping
Read the current card with GET /readcard
Write credits to the current card with POST /writecard

Base URL:

http://localhost:60000

Authentication

Partners receive an API key from the SportyWallet integration team upon request.

Header to use:

X-Api-Key: <your-api-key>

Authentication is currently required for POST /writecard.

Getting Started

Before making API calls, ensure the following:

The Worker service is running on the host machine. You can verify this by calling GET /ping.
Your integration origin is allowlisted when browser-based access is required.
You have received a valid X-Api-Key from the SportyWallet integration team.
You are targeting http://localhost:60000.

Quick Test Flow

Call GET /ping to confirm that the Worker is reachable.
Place a card on the reader and call GET /readcard.
Send a recharge request to POST /writecard with the X-Api-Key header and a JSON body containing credits.

Example request:

POST /writecard HTTP/1.1
Host: localhost:60000
X-Api-Key: your-api-key
Content-Type: application/json

{
    "credits": 1.5
}

Testing Tools

You can use the provided Postman assets to test the integration quickly:

Worker download by environments:

Dev environment: setup.exe
Production environment: setup.exe

Support

For API key provisioning, allowlisting requests, or integration support, contact the SportyWallet integration team.