# hamzadenizyilmaz/kargonomi-api architecture

> Architecture diagram of the GitHub repository hamzadenizyilmaz/kargonomi-api, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-01). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/hamzadenizyilmaz/kargonomi-api
- Repository: https://github.com/hamzadenizyilmaz/kargonomi-api

## Overview

This repository provides four independent Kargonomi API client implementations for application developers: ASP.NET Core, Node.js, PHP, and Python. In each, an application calls a client resource for operations such as shipments, pricing, locations, account credit, barcodes, warehouses, and webhooks; the resource sends HTTP requests through that client’s transport and returns decoded models or errors. Python additionally documents synchronous and asynchronous clients. Webhook signature verification is a separate capability. Edges reflect README statements and SOURCE INDEX references; unsampled resource details are grouped by their implementation directory, and unverified wiring is omitted.

Main entry points: [`Python/src/kargonomi/client.py`](https://github.com/hamzadenizyilmaz/kargonomi-api/blob/main/Python/src/kargonomi/client.py) (Python Clients), [`ASP.net/KargonomiAsp/Services/KargonomiClient.cs`](https://github.com/hamzadenizyilmaz/kargonomi-api/blob/main/ASP.net/KargonomiAsp/Services/KargonomiClient.cs) (.NET Client), [`NodeJS/src/resources.ts`](https://github.com/hamzadenizyilmaz/kargonomi-api/blob/main/NodeJS/src/resources.ts) (API Resources), [`PHP/src/Http/CurlTransport.php`](https://github.com/hamzadenizyilmaz/kargonomi-api/blob/main/PHP/src/Http/CurlTransport.php) (cURL Transport)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_dotnet["ASP.NET Core"]
  node_dotnet_client[".NET Client<br/>[KargonomiClient.cs]"]
  node_dotnet_resources["API Resources<br/>[Services]"]
  node_dotnet_options["Client Options"]
  node_dotnet_pipeline["HTTP Pipeline"]
  node_dotnet_models["API Models<br/>[Models]"]
  node_dotnet_webhook["Webhook Verification"]
end

subgraph group_node["Node.js"]
  node_node_client["Node Client<br/>[index.ts]"]
  node_node_resources["API Resources<br/>[resources.ts]"]
  node_node_transport["HTTP Transport<br/>[transport.ts]"]
  node_node_settings["Transport Settings<br/>[settings.ts]"]
  node_node_decoders["Response Decoders<br/>[decoders.ts]"]
  node_node_types["API Types<br/>[types.ts]"]
  node_node_webhook["Webhook Verification<br/>[webhook.ts]"]
end

subgraph group_php["PHP"]
  node_php_client["PHP Client"]
  node_php_resources["API Resources"]
  node_php_transport["cURL Transport<br/>[CurlTransport.php]"]
  node_php_request["HTTP Request<br/>[Request.php]"]
  node_php_response["HTTP Response<br/>[Response.php]"]
  node_php_decoder["Response Decoder<br/>[Decoder.php]"]
  node_php_webhook["Webhook Verification"]
end

subgraph group_python["Python"]
  node_python_client["Python Clients<br/>[client.py]"]
  node_python_resources["Sync Resources<br/>[resources.py]"]
  node_python_async["Async Resources<br/>[async_resources.py]"]
  node_python_transport["HTTP Transport<br/>[transport.py]"]
  node_python_core["Request Core<br/>[_core.py]"]
  node_python_models["API Models<br/>[models.py]"]
  node_python_webhook["Webhook Verification<br/>[webhook.py]"]
end

node_app(("Application"))
node_kargonomi_api{{"Kargonomi API"}}

node_app -->|"calls"| node_dotnet_client
node_dotnet_client -->|"exposes"| node_dotnet_resources
node_dotnet_client -->|"configures with"| node_dotnet_options
node_dotnet_client -->|"creates"| node_dotnet_pipeline
node_dotnet_resources -->|"sends through"| node_dotnet_pipeline
node_dotnet_resources -->|"uses"| node_dotnet_models
node_dotnet_pipeline -->|"sends HTTPS"| node_kargonomi_api
node_app -->|"calls"| node_node_client
node_node_client -->|"exposes"| node_node_resources
node_node_client -->|"configures"| node_node_transport
node_node_resources -->|"sends through"| node_node_transport
node_node_resources -->|"decodes with"| node_node_decoders
node_node_resources -->|"uses"| node_node_types
node_node_transport -->|"uses"| node_node_settings
node_node_transport -->|"sends HTTPS"| node_kargonomi_api
node_app -->|"calls"| node_php_client
node_php_client -->|"creates"| node_php_resources
node_php_client -->|"sends through"| node_php_transport
node_php_resources -->|"requests via"| node_php_client
node_php_resources -->|"decodes with"| node_php_decoder
node_php_transport -->|"accepts"| node_php_request
node_php_transport -->|"returns"| node_php_response
node_php_transport -->|"sends HTTPS"| node_kargonomi_api
node_app -->|"calls"| node_python_client
node_python_client -->|"exposes"| node_python_resources
node_python_client -->|"exposes"| node_python_async
node_python_client -->|"builds requests with"| node_python_core
node_python_client -->|"sends through"| node_python_transport
node_python_resources -->|"uses"| node_python_models
node_python_async -->|"uses"| node_python_models
node_python_transport -->|"sends HTTPS"| node_kargonomi_api

click node_dotnet_client "https://github.com/hamzadenizyilmaz/kargonomi-api/blob/main/ASP.net/KargonomiAsp/Services/KargonomiClient.cs"
click node_dotnet_resources "https://github.com/hamzadenizyilmaz/kargonomi-api/tree/main/ASP.net/KargonomiAsp/Services"
click node_dotnet_options "https://github.com/hamzadenizyilmaz/kargonomi-api/blob/main/ASP.net/KargonomiAsp/Configuration/KargonomiClientOptions.cs"
click node_dotnet_pipeline "https://github.com/hamzadenizyilmaz/kargonomi-api/blob/main/ASP.net/KargonomiAsp/Infrastructure/KargonomiHttpPipeline.cs"
click node_dotnet_models "https://github.com/hamzadenizyilmaz/kargonomi-api/tree/main/ASP.net/KargonomiAsp/Models"
click node_dotnet_webhook "https://github.com/hamzadenizyilmaz/kargonomi-api/blob/main/ASP.net/KargonomiAsp/Webhooks/WebhookSignatureVerifier.cs"
click node_node_client "https://github.com/hamzadenizyilmaz/kargonomi-api/blob/main/NodeJS/src/index.ts"
click node_node_resources "https://github.com/hamzadenizyilmaz/kargonomi-api/blob/main/NodeJS/src/resources.ts"
click node_node_transport "https://github.com/hamzadenizyilmaz/kargonomi-api/blob/main/NodeJS/src/transport.ts"
click node_node_settings "https://github.com/hamzadenizyilmaz/kargonomi-api/blob/main/NodeJS/src/settings.ts"
click node_node_decoders "https://github.com/hamzadenizyilmaz/kargonomi-api/blob/main/NodeJS/src/decoders.ts"
click node_node_types "https://github.com/hamzadenizyilmaz/kargonomi-api/blob/main/NodeJS/src/types.ts"
click node_node_webhook "https://github.com/hamzadenizyilmaz/kargonomi-api/blob/main/NodeJS/src/webhook.ts"
click node_php_client "https://github.com/hamzadenizyilmaz/kargonomi-api/blob/main/PHP/src/KargonomiClient.php"
click node_php_resources "https://github.com/hamzadenizyilmaz/kargonomi-api/tree/main/PHP/src/Resource"
click node_php_transport "https://github.com/hamzadenizyilmaz/kargonomi-api/blob/main/PHP/src/Http/CurlTransport.php"
click node_php_request "https://github.com/hamzadenizyilmaz/kargonomi-api/blob/main/PHP/src/Http/Request.php"
click node_php_response "https://github.com/hamzadenizyilmaz/kargonomi-api/blob/main/PHP/src/Http/Response.php"
click node_php_decoder "https://github.com/hamzadenizyilmaz/kargonomi-api/blob/main/PHP/src/Resource/Decoder.php"
click node_php_webhook "https://github.com/hamzadenizyilmaz/kargonomi-api/blob/main/PHP/src/KargonomiClient.php"
click node_python_client "https://github.com/hamzadenizyilmaz/kargonomi-api/blob/main/Python/src/kargonomi/client.py"
click node_python_resources "https://github.com/hamzadenizyilmaz/kargonomi-api/blob/main/Python/src/kargonomi/resources.py"
click node_python_async "https://github.com/hamzadenizyilmaz/kargonomi-api/blob/main/Python/src/kargonomi/async_resources.py"
click node_python_transport "https://github.com/hamzadenizyilmaz/kargonomi-api/blob/main/Python/src/kargonomi/transport.py"
click node_python_core "https://github.com/hamzadenizyilmaz/kargonomi-api/blob/main/Python/src/kargonomi/_core.py"
click node_python_models "https://github.com/hamzadenizyilmaz/kargonomi-api/blob/main/Python/src/kargonomi/models.py"
click node_python_webhook "https://github.com/hamzadenizyilmaz/kargonomi-api/blob/main/Python/src/kargonomi/webhook.py"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_dotnet_client,node_dotnet_resources,node_dotnet_options,node_dotnet_pipeline,node_dotnet_models,node_dotnet_webhook toneBlue
class node_node_client,node_node_resources,node_node_transport,node_node_settings,node_node_decoders,node_node_types,node_node_webhook toneAmber
class node_php_client,node_php_resources,node_php_transport,node_php_request,node_php_response,node_php_decoder,node_php_webhook,node_kargonomi_api toneMint
class node_python_client,node_python_resources,node_python_async,node_python_transport,node_python_core,node_python_models,node_python_webhook toneRose
class node_app toneIndigo
```

## Components

### ASP.NET Core

- [.NET Client](https://github.com/hamzadenizyilmaz/kargonomi-api/blob/main/ASP.net/KargonomiAsp/Services/KargonomiClient.cs): `ASP.net/KargonomiAsp/Services/KargonomiClient.cs`
- [API Resources](https://github.com/hamzadenizyilmaz/kargonomi-api/tree/main/ASP.net/KargonomiAsp/Services): `ASP.net/KargonomiAsp/Services`
- [Client Options](https://github.com/hamzadenizyilmaz/kargonomi-api/blob/main/ASP.net/KargonomiAsp/Configuration/KargonomiClientOptions.cs): `ASP.net/KargonomiAsp/Configuration/KargonomiClientOptions.cs`
- [HTTP Pipeline](https://github.com/hamzadenizyilmaz/kargonomi-api/blob/main/ASP.net/KargonomiAsp/Infrastructure/KargonomiHttpPipeline.cs): `ASP.net/KargonomiAsp/Infrastructure/KargonomiHttpPipeline.cs`
- [API Models](https://github.com/hamzadenizyilmaz/kargonomi-api/tree/main/ASP.net/KargonomiAsp/Models): `ASP.net/KargonomiAsp/Models`
- [Webhook Verification](https://github.com/hamzadenizyilmaz/kargonomi-api/blob/main/ASP.net/KargonomiAsp/Webhooks/WebhookSignatureVerifier.cs): `ASP.net/KargonomiAsp/Webhooks/WebhookSignatureVerifier.cs`

### Node.js

- [Node Client](https://github.com/hamzadenizyilmaz/kargonomi-api/blob/main/NodeJS/src/index.ts): `NodeJS/src/index.ts`
- [API Resources](https://github.com/hamzadenizyilmaz/kargonomi-api/blob/main/NodeJS/src/resources.ts): `NodeJS/src/resources.ts`
- [HTTP Transport](https://github.com/hamzadenizyilmaz/kargonomi-api/blob/main/NodeJS/src/transport.ts): `NodeJS/src/transport.ts`
- [Transport Settings](https://github.com/hamzadenizyilmaz/kargonomi-api/blob/main/NodeJS/src/settings.ts): `NodeJS/src/settings.ts`
- [Response Decoders](https://github.com/hamzadenizyilmaz/kargonomi-api/blob/main/NodeJS/src/decoders.ts): `NodeJS/src/decoders.ts`
- [API Types](https://github.com/hamzadenizyilmaz/kargonomi-api/blob/main/NodeJS/src/types.ts): `NodeJS/src/types.ts`
- [Webhook Verification](https://github.com/hamzadenizyilmaz/kargonomi-api/blob/main/NodeJS/src/webhook.ts): `NodeJS/src/webhook.ts`

### PHP

- [PHP Client](https://github.com/hamzadenizyilmaz/kargonomi-api/blob/main/PHP/src/KargonomiClient.php): `PHP/src/KargonomiClient.php`
- [API Resources](https://github.com/hamzadenizyilmaz/kargonomi-api/tree/main/PHP/src/Resource): `PHP/src/Resource`
- [cURL Transport](https://github.com/hamzadenizyilmaz/kargonomi-api/blob/main/PHP/src/Http/CurlTransport.php): `PHP/src/Http/CurlTransport.php`
- [HTTP Request](https://github.com/hamzadenizyilmaz/kargonomi-api/blob/main/PHP/src/Http/Request.php): `PHP/src/Http/Request.php`
- [HTTP Response](https://github.com/hamzadenizyilmaz/kargonomi-api/blob/main/PHP/src/Http/Response.php): `PHP/src/Http/Response.php`
- [Response Decoder](https://github.com/hamzadenizyilmaz/kargonomi-api/blob/main/PHP/src/Resource/Decoder.php): `PHP/src/Resource/Decoder.php`
- [Webhook Verification](https://github.com/hamzadenizyilmaz/kargonomi-api/blob/main/PHP/src/KargonomiClient.php): `PHP/src/KargonomiClient.php`

### Python

- [Python Clients](https://github.com/hamzadenizyilmaz/kargonomi-api/blob/main/Python/src/kargonomi/client.py): `Python/src/kargonomi/client.py`
- [Sync Resources](https://github.com/hamzadenizyilmaz/kargonomi-api/blob/main/Python/src/kargonomi/resources.py): `Python/src/kargonomi/resources.py`
- [Async Resources](https://github.com/hamzadenizyilmaz/kargonomi-api/blob/main/Python/src/kargonomi/async_resources.py): `Python/src/kargonomi/async_resources.py`
- [HTTP Transport](https://github.com/hamzadenizyilmaz/kargonomi-api/blob/main/Python/src/kargonomi/transport.py): `Python/src/kargonomi/transport.py`
- [Request Core](https://github.com/hamzadenizyilmaz/kargonomi-api/blob/main/Python/src/kargonomi/_core.py): `Python/src/kargonomi/_core.py`
- [API Models](https://github.com/hamzadenizyilmaz/kargonomi-api/blob/main/Python/src/kargonomi/models.py): `Python/src/kargonomi/models.py`
- [Webhook Verification](https://github.com/hamzadenizyilmaz/kargonomi-api/blob/main/Python/src/kargonomi/webhook.py): `Python/src/kargonomi/webhook.py`

### Other components

- **Application**
- **Kargonomi API**

## Connections

- Application → .NET Client: calls (evidence: `README.md`)
- .NET Client → API Resources: exposes (evidence: `ASP.net/KargonomiAsp/Services/KargonomiClient.cs`)
- .NET Client → Client Options: configures with (evidence: `ASP.net/KargonomiAsp/Services/KargonomiClient.cs`)
- .NET Client → HTTP Pipeline: creates (evidence: `ASP.net/KargonomiAsp/Services/KargonomiClient.cs`)
- API Resources → HTTP Pipeline: sends through (evidence: `ASP.net/KargonomiAsp/Services/ShipmentsResource.cs`)
- API Resources → API Models: uses (evidence: `ASP.net/KargonomiAsp/Services/ShipmentsResource.cs`)
- HTTP Pipeline → Kargonomi API: sends HTTPS (evidence: `README.md`)
- Application → Node Client: calls (evidence: `README.md`)
- Node Client → API Resources: exposes (evidence: `NodeJS/src/index.ts`)
- Node Client → HTTP Transport: configures (evidence: `NodeJS/src/index.ts`)
- API Resources → HTTP Transport: sends through (evidence: `NodeJS/src/resources.ts`)
- API Resources → Response Decoders: decodes with (evidence: `NodeJS/src/resources.ts`)
- API Resources → API Types: uses (evidence: `NodeJS/src/resources.ts`)
- HTTP Transport → Transport Settings: uses (evidence: `NodeJS/src/transport.ts`)
- HTTP Transport → Kargonomi API: sends HTTPS (evidence: `README.md`)
- Application → PHP Client: calls (evidence: `README.md`)
- PHP Client → API Resources: creates (evidence: `PHP/src/KargonomiClient.php`)
- PHP Client → cURL Transport: sends through (evidence: `PHP/src/KargonomiClient.php`)
- API Resources → PHP Client: requests via (evidence: `PHP/src/Resource/ShipmentsResource.php`)
- API Resources → Response Decoder: decodes with (evidence: `PHP/src/Resource/ShipmentsResource.php`)
- cURL Transport → HTTP Request: accepts (evidence: `PHP/src/Http/CurlTransport.php`)
- cURL Transport → HTTP Response: returns (evidence: `PHP/src/Http/CurlTransport.php`)
- cURL Transport → Kargonomi API: sends HTTPS (evidence: `README.md`)
- Application → Python Clients: calls (evidence: `README.md`)
- Python Clients → Sync Resources: exposes (evidence: `Python/src/kargonomi/client.py`)
- Python Clients → Async Resources: exposes (evidence: `Python/src/kargonomi/client.py`)
- Python Clients → Request Core: builds requests with (evidence: `Python/src/kargonomi/client.py`)
- Python Clients → HTTP Transport: sends through (evidence: `Python/src/kargonomi/client.py`)
- Sync Resources → API Models: uses (evidence: `Python/src/kargonomi/resources.py`)
- Async Resources → API Models: uses (evidence: `Python/src/kargonomi/async_resources.py`)
- HTTP Transport → Kargonomi API: sends HTTPS (evidence: `README.md`)
