@orchesty/connector-gobalik
v2.0.2
Published
Readme
GO balik Connector
An Orchesty connector for GO balik, a transport service for parcels and pallets within the Czech Republic and neighbouring countries.
Application Type
Basic
This connector authenticates using a username and password encoded as HTTP Basic auth in the Authorization header.
| Field | Description |
|---|---|
| user | Your GO balik username (email) |
| password | Your GO balik API password |
Components
| Class | Type | Description |
|---|---|---|
| GObalikCreateOrderConnector | Connector | Creates a new shipment order via POST /api/v1/order/ |
| GObalikOrderListConnector | Connector | Retrieves a list of orders filtered by date range and optional ID via GET /api/v1/order |
| GObalikOrderDetailConnector | Connector | Retrieves full detail of a single order by hash via GET /api/v1/order/{hash} |
Setup
Credentials
- Log in to your GO balik account.
- Navigate to Nastavení (Settings) and locate your API credentials.
- Copy your username (email) and API token and paste them into the corresponding fields in Orchesty.
Installation & Usage
Install the package:
npm install @orchesty/connector-gobalik @orchesty/nodejs-sdk
# or
pnpm add @orchesty/connector-gobalik @orchesty/nodejs-sdkRegister the application and nodes in your Orchesty DI container:
import { container } from '@orchesty/nodejs-sdk';
import GObalikApplication from '@orchesty/connector-gobalik/dist/GObalikApplication';
import GObalikCreateOrderConnector from '@orchesty/connector-gobalik/dist/Connectors/GObalikCreateOrderConnector';
import GObalikOrderListConnector from '@orchesty/connector-gobalik/dist/Connectors/GObalikOrderListConnector';
import GObalikOrderDetailConnector from '@orchesty/connector-gobalik/dist/Connectors/GObalikOrderDetailConnector';
const app = new GObalikApplication();
container.setApplication(app);
container.setNode(new GObalikCreateOrderConnector(), app);
container.setNode(new GObalikOrderListConnector(), app);
container.setNode(new GObalikOrderDetailConnector(), app);License
This connector is released under the Apache License 2.0. See the LICENSE file for the full license text.
Contributing
Contributions are welcome! This connector is part of the open-source Orchesty Node.js Connectors monorepo.
For guidelines on how to create or update connectors — including project setup, coding conventions, and how to write tests — please refer to the Contributing to Connectors guide.
All contributions should include:
- Source code in
src/following the existing connector structure - Tests in
src/**/__tests__/withinput.json,mock.json, andoutput.jsonfixtures - An updated
CHANGELOG.mdentry
