Versions Compared

Old Version 10

changes.mady.by.user Aryn Wiebe

Saved on

compared with

New Version 11

changes.mady.by.user Aryn Wiebe

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Expand
titleUse Custom Fields to pass configurations and parameters

Avoid hardcoding configurations and parameters. Centralize configuration data in Custom Fields to make the interface adaptable and more secure.

Information such as the base URL, authentication data (clientID, client secrets, username, password, tokens, etc.), and retry logic are good candidates for custom fields!

This way, you can update configurations without modifying the core logic of your API calls. screenshot

Here we are passing createOrder() configurations and order details to use to prepare the API call:

Image AddedImage Added
Expand
titlePass parameters as a table of parameters when calling your API

Using tables to store parameters allows you to dynamically build the data you need to send with the request. It also keeps your functions simple and support multiple optional parameters.

In this example, we are passing the endpoint, body and live parameter in a single table for apiCall() to use to perform the HTTP request.

We are also passing the method, to apiCall() which is set up to make various http calls (e.g., get, put, post.

Image Added
Expand
titlePreparing the body or query string parameters

In this example, we are working with JSON data. Notice in createOrder.lua we are first serializing the JSON as a string to prepare it for the body of the request.

Image Added

Depending on the API you’re working with and the type of request, there are a few functions that you may want to use to prepare the body or query string parameters:

  • For JSON: json.serialize{} to convert a Lua table to a string

  • For XML: tostring() or :S() to convert an XML node tree to a string

  • For query strings: with net.http.get() use the parameters argument to pass a table of query parameters and values to automatically append them to the URL.

Expand
titleUse Build in resiliency to you HTTP requests using pcall and retry logic

Make your integration more robust by handling errors and retrying calls when necessary. This is particularly useful for handling intermittent network or server issues.

For example

Now, looking at apiCall()

, you can see pcall()

, Retry Library
Expand
titleSet a timeout
Prevent requests from hanging indefinitely by specifying a timeout parameter in

and the Retry Library are used when making the net.http.* API call:

Image Added

See Handling HTTP Response for the fundamentals and recommendations on how to handle responses in IguanaX.

Expand
titleDocument your functions!

Create Help Files (*.help) to document how your functions work and how to use them will make it easier for the rest of the team to understand and reuse your functions.

If you are a more advanced user or are building a complex integration, refer to our Shell Adapter for a great template framework to structure your web client adapters to any API system.

...