> For the complete documentation index, see [llms.txt](https://docs.ixhello.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.ixhello.com/ixhc/general/use-cases/contact-finder-with-rest-api/prerequisites/integrate-api-service-with-ix-hello.md).

# Integrate API Service with iX Hello

You could integrate any public API-Service with iX Hello with a simple set up. For this demonstration, we'll be using a third party sample API service.

On the left navigation, go to Integrations-> Connect System and Add New Connection.

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

On the resulting screen, Connect External System and choose System Type: Rest API Service and click on Next.

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

Now provide configurations for the API service you are trying to connect and click on Validate System.&#x20;

| Field                | Value                                                                                                                                                                                                               |
| -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| System Instance Name | <p>Unique name to identify your connection</p><p>e.g.API Service </p>                                                                                                                                               |
| Authorization Type   | <p>Authorization type </p><p>Options:</p><p>a. No Auth</p><p>b.  Bearer Token</p><p>c. Digest Auth</p><p>d. OAuth 1.0</p><p>e. OAuth 2.0</p><p>f. AWS Signature</p><p>g. NLM Authentication </p><p>e.g. No Auth</p> |
| Base API URL         | Base URL e.g. <https://jsonplaceholder.typicode.com/users>                                                                                                                                                          |

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

The application will try to validate and establish a connection, upon success, you'll be able to save the integration.&#x20;

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

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

Congratulations, you've successfully integrated to your API service with iX Hello. The created connection shall be available in the list of connections.

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

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


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.ixhello.com/ixhc/general/use-cases/contact-finder-with-rest-api/prerequisites/integrate-api-service-with-ix-hello.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.