Transformations

Transformations allow you to remove, remap, or add headers or parameters in API requests and API responses

Transformations allow you to remove, remap, or add headers or parameters in API requests and API responses transparently to the developer using the API. Currently, we support single object transformations and we will be launching more complex transformations in the future.

Transformation actions

Function

Description

Use case

ADD

Add a header or parameter to an API request or response.

Add a secret authentication parameter per plan in the case where each plan uses a different base URL (learn more about multi-base URLs here).

REMAP

Remap a header or parameter in an API request or response.

Remap request authentication from query to header to provide a better developer experience, without modifying the original API.

REMOVE

Remove a header or parameter in an API request or response.

Remove a parameter in the original API response so that it isn't displayed to the API consumer.

How to get started with transformations

To start, navigation to the Provider Dashboard and select the Definition page for the API you want to edit. Next, select the Transformations tab on the top navigation bar.

This screen allows you to remove, remap, or add headers or parameters in API requests and API responses.

How to define a transformation

Step 1: Select either Request Transformation or Response Transformation

Step 2: Select an action

You can set the action to Remove, Remap, or Add.

🚧

[IMPORTANT]

The Method and Base URL Transformations can only be done from the Edit Endpoint tab.

See the instructions for this process below.

Step 3: Define the target Key

You can select from the available options, and add more detail using dot notation.

Step 4: Select a variable type

You can select from Static, Variable, or Template.

  • Select type Static for if you want to send plain text/json or any fixed data
  • Select type Variable if you want to map the value from other parameters. Example request.header.xxxx
  • Select type Template if you want to read values from other variables and add more content and manipulate data. You can use the powerful mustache syntax to achieve complex mappings.

Example {{request.query.value}},{{request.body.item}} I am using transformation {{request.body.item2}}

Step 5: Set the variable value

Step 6: Set the scope of the transformation

Set the scope to include the full API or select specific endpoints.

Step 7: Select which subscription plans are impacted

You can choose to apply the transformation to all of the plans or select which specific plans it applies to.

How to add header "content-type" [Required if transforming methods]

While transforming methods, you must add the header "content-type" explicitly. To do this, you must leave the Transformations tab and navigate to the Endpoints tab. Click "Edit" on the desired endpoint.

From the Edit Endpoint page, select the Header tab. Add one of the following content-type headers to the Example Value field:

  • application/json
  • multipart/form-data
  • application/x-www-form-urlencoded

Save the changes once you are finished