Working with web services

There are different ways to integrate one system or application to another. Using an API is one such way.

In Linx this can be done in 2 ways:

  1. Using the Web plugin's functions of CallSOAPWebService or CallRESTWebService

  2. Using the available functions contained in Linx plugins that were developed to simplify the integration to specific systems, e.g. Amazon web services, Finswitch, Xero and QuickBooks,.


How web services work

There are 3 important concepts that form the basis of using web services for systems integration:

  • Endpoints
  • Requests
  • Responses

When you create a connection to a web service endpoint and send a request message, you should expect to receive a response.


Do the following:

First determine why you want to integrate with the other system:

  • your business requirements will determine which operations you will perform on the other system:
    • you may for example want to read (GET), create (POST), update (PUT), or delete data


Then...

1. Connect...

  • by providing connection details for the web service endpoint (e.g. base URL)

2. Be authenticated...

  • by providing your user authentication details, if required

3. Send request...

  • by using a specific method, e.g. GET, POST, PUT, DELETE
  • by including relevant input data via e.g. URL parameters, header or body details

4. Handle response...

  • by receiving the requested data, as well as success or failure responses
  • by processing the response data in your Linx solution to achieve your solution goal


How to use CallSOAPWebService

You will need the details of:

  • The method to call in the web service
  • The Service URL to use when making the SOAP call
  • Authentication details

Also see

CallSOAPWebService


How to use CallRESTWebService

You will need the details of:

  • Base URL for the request
  • Method type to use in the request (e.g. GET, POST, PUT, DELETE)
  • Authentication details
  • Query details (how to send request data and what data to send)
    • Query string (parameters to send with request)
    • Header details
    • Body details
  • Response output type

Also see

CallRESTWebService


How to use specific plugins to integrate

Xero

QuickBooks

Finswitch

Amazon Web Services