Saltbox API Gateway Overview

First published on: 02/21/2024/8:44 pm

Saltbox API Gateway

Saltbox API Gateway supports the creation of customized APIs, which securely and reliably integrate into any number of systems. Routes are built with customized business logic using Saltbox Integration workflows and our library of connectors.

Because Saltbox API Gateway relies on workflows, all the tools available to a workflow can be used to support API customization and troubleshooting. These include workflow message trace, visual data mapper, and iterative testing tools.

Best Practices

Request/Response

Saltbox API Gateway supports synchronous requests, whose responses must be provided within 30 seconds. To support timely responses, you should optimize workflows for speed and message size.

• Requests and responses should be kept as small as possible.
• Send only what’s necessary to complete a request (for example, send targeted fields rather than a whole data object).

Workflow design

• Minimize the number of actions to keep the workflow succinct.
• Minimize data object and query lookups. The more external touchpoints, the longer the workflow will take to execute.
  • To minimize external touchpoints, use efficient, targeted queries where possible (vs. general-purpose data object lookups).
    • E.g., One object request in SAP Business One does secondary lookups for related data. This can add delays in workflow execution.

Limits

Saltbox API Gateway supports a request-response pattern of synchronous workflow execution.

Due to technical limitations, all synchronous requests must be completed within 30 seconds.

Request and response sizes should be limited to 100 KB to avoid adding delays to the response. Larger sizes are possible but may result in workflow timeouts.

Next