How pitwch/go-wrapper-proffix-restapi works
This is a Go wrapper and CLI for the PROFFIX REST API. The main workflow configures a client, establishes a Px session, sends endpoint requests, and returns response bodies, headers, statuses, or structured API errors. Additional supported capabilities include paginated reads, item-by-item synchronization, file transfer, metadata/info helpers, and local response/file parsing. The CLI exposes GET and POST. Architecture links are limited to calls shown in the sampled source; README-documented methods whose internal wiring was not sampled are represented as client capabilities, not speculative flows.
Main entry points: client.go CRUD methods · main.go REST CLI · helper.go Response helpers · file.go File upload
Components 15
Entry points
- REST CLI
cmd/proffix-rest/main.go
Client and sessions
- Client setup
proffixrest/client.go - Session lifecycle
proffixrest/client.go - HTTP requests
proffixrest/client.go
API operations
- CRUD methods
proffixrest/client.go - Info endpoints
proffixrest/client.go - File upload
proffixrest/file.go - File download
proffixrest/file.go
Batch and utilities
- Paginated reads
proffixrest/batch.go - Batch sync
proffixrest/sync_batch.go - Response helpers
proffixrest/helper.go - API errors
proffixrest/error.go - Local file output
proffixrest/helper.go
Other components
- Go caller
- PROFFIX REST API
Connections 26
- Go caller → Client setup: configures
- Go caller → CRUD methods: calls
- Go caller → Paginated reads: calls
- Go caller → Batch sync: calls
- Go caller → File upload: calls
- Go caller → File download: calls
- Go caller → Info endpoints: calls
- Go caller → Response helpers: uses
- Go caller → Local file output: uses
- REST CLI → Client setup: creates
- REST CLI → CRUD methods: dispatches
- REST CLI → Response helpers: formats
- REST CLI → Session lifecycle: logs out
- CRUD methods → Session lifecycle: ensures login
- CRUD methods → HTTP requests: sends request
- Info endpoints → HTTP requests: sends request
- File upload → Session lifecycle: ensures login
- File upload → HTTP requests: sends request
- File download → CRUD methods: fetches metadata
- Paginated reads → CRUD methods: requests pages
- Paginated reads → Response helpers: reads count
- Batch sync → CRUD methods: checks and writes
- HTTP requests → PROFFIX REST API: HTTP exchange
- Session lifecycle → PROFFIX REST API: login/logout
- HTTP requests → API errors: decodes failures
- Response helpers → Local file output