Create a Service Connection from an Endpoint

You create a connection from an endpoint when you know the base URI of a service and can provide the necessary parameters for connecting to the service, such as authentication details and an example of the body of the Response.

To create a service connection from the URL of an endpoint:

  1. Open Service Connections in the Navigator and click Create Service Connection ( Create Service Connection icon ).
  2. Click Define by Endpoint in the Select Source pane of the Create Service Connection wizard.
  3. Select the HTTP method and type the URL of the endpoint. Click Next.

    If you know what type of action you want to perform, select it in the Action Hint dropdown list.

    Description of service-connections-create-specifyendpoint.png follows
    Description of the illustration service-connections-create-specifyendpoint.png
  4. In the Service tab, Confirm that the Service Base URL, Service Name and Service ID are correct.
    Depending on the endpoint that you specified, these values might be automatically populated for you.
  5. Open the Authentication tab and select Enable authentication / proxy to enter authentication details, if required.
    Enable authentication / proxy is disable by default.
  6. Open the Request tab to add Headers and URL parameters to the request.

    Depending on the endpoint, you might want to add custom headers or path or query parameters that are passed as part of the Request.


    Description of service-connections-specifyendpoint-request.png follows
    Description of the illustration service-connections-specifyendpoint-request.png
  7. Open the Response tab and enter the response body for the endpoint.

    The Response tab contains a text area where you can paste in an example of the body of the response. The example in the Response is the definition of the structure of the returned object. If you do not have an example, you can use the Test tab to send a request to the service and view the response. You can edit the response body in the text area in the Response tab.


    Description of service-connections-specifyendpoint-response.png follows
    Description of the illustration service-connections-specifyendpoint-response.png
  8. Open the Test tab to test your request and view the response from the endpoint.

    Click Send to view the Response body and headers that will be received to confirm that you will receive the data you want.


    Description of service-connections-specifyendpoint-test.png follows
    Description of the illustration service-connections-specifyendpoint-test.png

    You can experiment with the different request parameters until you achieve the response you want.

    You use the Test tab to test the service and view the response to the request that will be sent to the endpoint based on the settings in the other tabs. If your response returns an error you will need to check the details of your connection, for example, to ensure that you are using the correct credentials or that the service uses a valid SSL certificate. For development purposes you can try to enabling Token Relay for authentication if the service supports it.

  9. Click Copy to Response Body to copy the current response into the text area in the Response tab, where you can edit it further if you require
  10. Click Create when you are satisfied with the parameters of your request and the response.

Tip:

After you add an endpoint from the service, you can add more endpoints from the same service by clicking + Endpoints in the Endpoints tab of the connection and choosing From Original Service in the menu.