edoc automate Guide
edoc automate Guide
Breadcrumbs

Create a web service endpoint in edoc automate

You can create any web service endpoints.

Things to know

  • Each web service endpoint must have a unique name. Give your endpoints "descriptive" names.

  • The capitalization of names is ignored.

Here's how

  1. Click on New Endpoint in the sidebar of your app project.

  2. Enter a unique name and a description for the new endpoint in the Add Web Service Endpoint dialog.

  3. Click on Add to open the editor of the web service endpoint.

  4. Configure the details for the endpoint in the General section under Path, HTTP Methods, and Response.

You must configure the following details for a web service endpoint:

  • Path > Route: Use the route to specify the URL via which the endpoint can be reached. You can also specify parameters via the route so that the endpoint can be controlled directly via the URL.

  • HTTP Methods: You can use the HTTP method to specify which requests the endpoint should respond to. The following methods are supported by default:

    • GET

    • POST

    • PUT

    • DELETE

  • Response: Specify the format for the return of the web service. The following formats are supported by default:

    • Raw: The return of the actions is sent to the calling client app without adjustments or conversion.

    • JSON: The return of the actions is converted into JSON.

    • XML: The return of the actions is converted into XML.

You can also implement other return formats with plug-ins.

In the Actions section, you can create any actions in the web service endpoint. It is not necessary for the actions to be filled with a specific element. You only need to ensure that the action returns a single value or a record. The return of the action is processed by the selected plug-in when it is returned.

In the Authentication section, you can specify whether authentication and authorization should be requested when the web service endpoint is called up. By default, you can use the following authentication methods:

  • Noauth: No authentication is checked.

  • Basicauth: The system checks for HTTP basic authentication with user name and password.

  • Apikey: The system checks for a specific value in a defined HTTP header.

If authentication fails, a corresponding error message is displayed.

You can use the parameters of the authentication procedures to return actions. To do this, you must create an action for each parameter that supports actions using Add Action.

You can find the new web service endpoint in the sidebar in the Web Service Endpoints section. You can edit the endpoint directly by clicking on the endpoint to open the editor.

You can open several endpoints at the same time and switch back and forth between the endpoints in the app's navigation bar.


See also