REST

Expose REST APIs and call external ones, all in Python.

Get started

Give every service an HTTP endpoint that clients call - JSON in, JSON out, secured the way you choose.

Expose APIs

Channels Expose services as REST endpoints with security, data formats and URL parameters. HTTP verbs Handle GET, POST, PUT, PATCH and DELETE in one service or in separate ones. URL path matching Path parameters, match priorities and every option that shapes request routing. Auto-created channels Channels created automatically for deployed services, driven by environment variables. Webhooks Receive webhooks from external systems and route each event to a service. CORS Let browsers call your channels across origins, with preflight requests handled. Versioning Version your APIs through URL paths and keep old consumers working.

Call APIs

Calling REST APIs Invoke external REST APIs from services, with JSON parsed into Python objects. Outgoing connections Configure connection pools, TLS, timeouts and security for external APIs. REST adapter Bridge REST APIs without writing code, mapping requests and responses in configuration. API gateways Put Zato behind or in front of API gateways and integrate with existing ones.

Security

Authentication Basic Auth, API keys and bearer tokens for channels, NTLM for outgoing connections. Security groups Many credentials on one channel, with mTLS channels and the proxy header contract. Custom authentication Implement your own authentication logic when the built-in methods are not enough.

Data and errors

Data mapping Map and transform data between systems with plain Python dictionaries and models. Orchestration Call multiple APIs in one service and combine their responses into one reply. Error handling Return errors to callers and handle the errors external APIs return to you. Error catalog Every status code a channel returns, what causes it and what to check. File uploads and downloads Accept file uploads in channels and download files from external APIs. Cloud storage Store and retrieve files in cloud storage from your REST services. SQL stored procedures Expose SQL queries and stored procedures as REST endpoints. Enmasse reference The full channel_rest field reference for enmasse YAML, with every key explained.

OpenAPI

OpenAPI specifications Generate OpenAPI specifications from your services and their data models. OpenAPI console Live API documentation with a try-it client, showing each caller their endpoints.