advpl-webservice

What problem does it solve?

It helps you implement and migrate Protheus Web Services by choosing the right REST family (REST classic WSRESTFUL vs TL++ notation) or SOAP style, while avoiding common REST pitfalls that break security, encoding, or routing.

Core Features & Use Cases

• Design REST endpoints safely: Pick TL++ notation with @Get/@Post/@Put/@Patch/@Delete/@Options, including proper status codes, response handling, CORS preflight, and UTF-8 boundary encoding (DecodeUTF8/EncodeUTF8).
• Migrate and interoperate: Convert WSRESTFUL/WSSERVICE/WSMETHOD REST classic patterns into notation-based endpoints (including path params and body parsing differences), and understand version prerequisites (AppServer 20+ with tlppCore).
• Secure multi-tenant APIs: Configure PrepareIn + TenantId in appserver.ini and validate/avoid insecure patterns like RpcSetEnv in REST (SEC-001).
• Support SOAP when required: Define WSSERVICE/WSDATA/WSMETHOD/WSSTRUCT for legacy integrations.

Quick Start

Implement a REST tlppCore endpoint by using @Get or @Post with the correct endpoint, parsing path/query/body via oRest methods, setting HTTP status/response once, and ensuring you decode request UTF-8 and encode JSON responses back to UTF-8.