> For the complete documentation index, see [llms.txt](https://docs.emobiq.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.emobiq.com/emobiq-ai/readme/external-api/ez-connect.md).

# EZ-Connect

EZ-Connect makes integration easier than ever, enabling you to connect to third-party services using natural language — whether it's the SAP Business Connector model or even plain English.

It's the no-code path for users who already have API information (vendor docs, integration guides, sample requests) but aren't comfortable wiring it up through the standard POSTMAN-like editor used in the [External API](/emobiq-ai/readme/external-api.md) setup.

{% hint style="warning" %}
*EZ-Connect is intended for **experimentation and prototyping only**. Because the configuration cannot be tested or verified at setup time, behaviour may be inconsistent and is not recommended for production workloads.*
{% endhint %}

***

### When to Use EZ-Connect

EZ-Connect is the right choice when:

* You're a non-technical user with API documentation but no API tooling experience
* You're building a quick prototype or proof-of-concept
* You only have natural-language docs (e.g., the SAP Business Connector model) and no OpenAPI schema
* You're putting together a throwaway demo and need to move fast

***

### How It Works

The URL, target connection, and freeform input you provide are passed to the AI as an **instruction set**. The AI interprets these instructions when generating API calls at runtime — meaning the integration is only as reliable as the description you give it.

Unlike the standard External API setup, there is **no test or verify step**. You cannot validate the endpoint, headers, authentication, or response shape before the AI uses it during app generation.

***

### Setting Up an EZ-Connect Integration

<figure><img src="/files/ImlRjKqonnc7dLfYW4MP" alt=""><figcaption></figcaption></figure>

{% stepper %}
{% step %}
**URL**

Enter the base URL or endpoint of the third-party service you want to connect to.
{% endstep %}

{% step %}
**Save To**

Select the connection (e.g., `Acumatica`) that the EZ-Connect instructions will be attached to.
{% endstep %}

{% step %}
**Your Input**

Paste your natural-language API documentation, SAP Business Connector model text, or a plain-English description of how the API works. Cover:

* Authentication (e.g., "Use a Bearer token in the `Authorization` header")
* Available endpoints and HTTP methods
* Required parameters or request bodies
* Expected response shape, if known
  {% endstep %}

{% step %}
**Save**

Click `Save` to store the input as an instruction set for the AI to reference during app generation.
{% endstep %}
{% endstepper %}

***

### EZ-Connect vs. Standard External API Setup

| Criteria             | EZ-Connect                           | Standard External API                             |
| -------------------- | ------------------------------------ | ------------------------------------------------- |
| Target user          | Non-technical users                  | Developers / system integrators                   |
| Input format         | Natural language / plain text        | Structured fields (URL, headers, body, auth)      |
| Authentication setup | Described in plain text              | Explicit (Basic, API Key, Bearer, JWT, OAuth 2.0) |
| Endpoint testing     | Not available                        | Built-in `Test` button with response inspection   |
| Response shaping     | Not available                        | Formatted/Raw editor to trim unused fields        |
| Verifiability        | Cannot verify before generation      | Verified end-to-end before use                    |
| Accuracy             | Lower — depends on AI interpretation | Higher — deterministic configuration              |
| Schema import        | Not supported                        | Supports OpenAPI 3.0 import                       |
| Best for             | Prototypes, experiments, demos       | Production integrations                           |

***

### Limitations

{% hint style="danger" %}
EZ-Connect trades accuracy and verifiability for ease of use. Be aware of the following before relying on it:

* No request validation or test execution before generation
* Quality depends entirely on the clarity of the pasted instructions
* The AI may hallucinate fields or behaviour the API does not actually expose
* Not suitable for sensitive data flows or production workloads
* Authentication handling is best-effort — complex flows such as [OAuth 2.0](/emobiq-ai/readme/external-api/oauth-2.0.md) token refresh should use the standard setup
  {% endhint %}

***

### Tips for Better Results

{% hint style="success" %}
The clearer your instructions, the better EZ-Connect performs:

* Include the full base URL and a list of endpoints with their HTTP methods
* State the auth mechanism plainly (e.g., *"Use a Bearer token in the `Authorization` header"*)
* Provide example requests and example responses where possible
* Keep each EZ-Connect entry focused on a single logical group of endpoints
  {% endhint %}

***

### When to Graduate to the Standard Setup

Once your prototype is validated and you need accuracy, testability, and production-grade authentication, move the integration to the standard [External API](/emobiq-ai/readme/external-api.md) flow — and use [OAuth 2.0](/emobiq-ai/readme/external-api/oauth-2.0.md) for any auth flow that requires token exchange or refresh.