• manage entry points: add, modify, delete.
• view the description of the current REST web service.
• create OpenAPI documentation for the current REST web service.

• Create entry points. For more details, see Create entry points.
• Modify an entry point directly from the editor.
• Duplicate an entry point.
• Delete an entry point.

Modifying an entry point

1. Entry point description.
2. HTTP method: Method representing the action to be performed (GET, PUT, etc.).
3. Request format: Format of data passed in the REST call.
4. Response format: Format of data retrieved in the response of a REST call.
5. Resource or part of the entry point URL.
6. Associated procedure: WLanguage procedure associated with the entry point.
7. Automatic deserialization: The data passed as parameters to POST, PUT or PATCH requests can be automatically deserialized in a parameter of the procedure associated with the entry point.
8. New in version 2025
   Scopes: Permissions required to access this entry point.

• Common components.
• Prologue procedure.
• New in version 2025
  Authorization.

Common components

The resource is made of:

• static elements.
• variables elements.
• common parameters (optional).

The static elements represent the objects used. For example, "/Customers" to handle customers.
In the resource creation wizard, a static element corresponds to a "Fixed component".

The variable elements identify the resources used (a customer number, an order number, etc.). For example, "/Customers/{CustNum}" identifies the customer using a customer number.

• In the URL creation wizard, a variable element corresponds to:
  • a variable component defined by a procedure parameter. This component is automatically retrieved in the parameters of the associated WLanguage procedure.
  • a variable component retrieved programmatically with WebserviceParameter.
• A variable element is represented by the following syntax: "{Variable component name}".
  For example, "/Customers/10" allows you to manage customers with an identifier set to 10.
• It is quite common to pass variables elements in the URL when calling a REST function.
• Each variable component (retrieved programmatically) of the resource corresponds to a parameter passed to the WLanguage procedure associated with the entry point.
• A variable element is represented by a name when defining the address of the entry point in the editor. For a variable component retrieved programmatically, this name must be identical to the name of the parameter in the WLanguage procedure associated with the entry point.
  At runtime, the value passed in the resource (URL) will be retrieved and placed in the variable. This name is case sensitive. Therefore, it is very important to use the same name in the procedure and in the resource (or vice versa), otherwise a runtime error occurs.

You can combine several static and variable elements. For example:

• "/Customers/{CustomerID}/Invoices" to retrieve the invoices of a customer identified by their customer ID.
• "/Suppliers/{SupID}/Products/{ProdRef}" to retrieve the product identified by "ProdRef" for the supplier identified by "SupID".

Prologue procedure

Authorization

• Defining trusted servers
  First of all, you need to enter the details of the user authentication or authorization servers.
  To define authentication (OpenID Connect) or authorization (OAuth 2.0) servers:
  • Click "+" at the top of the window to add as many servers as required.
  • Specify the characteristics of each server:
    
    • Server address,
    • Token validation key or introspection URL provided by the server. Only one of these elements is required.
  

  Token validation key (signature verification).
  The key depends on the signature used by the server:

  • "HS256"/"HS384"/"HS512" signatures: A secret key is used (shared with the server). The key is a binary value generally in hexadecimal format.
  • "RS256"/"RS384"/"RS512" signatures: The server's public key is used. The key is a string. It is generally represented as a multiline text starting with -----BEGIN PUBLIC KEY-----
• Defining scopes
  In the lower section of the window, you can enter the list of scopes that may be required to address a web service entry point.