|
| 1 | +--- |
| 2 | +sidebar_title: Quickstart |
| 3 | +page_title: Setu Insights quickstart |
| 4 | +order: 1 |
| 5 | +visible_in_sidebar: true |
| 6 | +--- |
| 7 | + |
| 8 | +## Quickstart Guide |
| 9 | + |
| 10 | +Here is a quick summary of steps to help you integrate with Setu’s Insights API. Before you start, there are some key terms that will be referred to periodically in the documentation— |
| 11 | + |
| 12 | +- **FI Data block**—FI Data blocks are the data received from the FIP (Financial information provider), via the AA. Currently, we only support bank statement datablock. |
| 13 | +- **Template**—A template is a pre-configured format that determines the structure of the generated report, including which insights to generate. You can pick and choose exactly what insights should be added to a template, based on your needs. For example, if you only want to generate income and expense insights of a customer, the template can contain only those two insights. |
| 14 | + |
| 15 | +<Callout type="tip"> |
| 16 | + Please refer to the Account Aggregator's{" "} |
| 17 | + <a href="/data/account-aggregator/quickstart#quickstart-guide" target="_blank"> |
| 18 | + quickstart guide |
| 19 | + </a>{" "} |
| 20 | + for key terms related to AA |
| 21 | +</Callout> |
| 22 | + |
| 23 | +<hr className="primary" /> |
| 24 | + |
| 25 | +<br /> |
| 26 | + |
| 27 | +### Step 1—Template creation |
| 28 | + |
| 29 | +You need to send in the below information to [insights@setu.co](mailto:insights@setu.co), for setting up your template. |
| 30 | + |
| 31 | +| | | |
| 32 | +| ------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | |
| 33 | +| **FIU ID** | This can be obtained from your AA integration | |
| 34 | +| **Notification endpoint** | An endpoint where Setu will send you webhook notifications for events. See <a href="/data/insights/notifications" target="_blank">notifications</a>. | |
| 35 | +| **Template name** | Choose a suitable name, which helps you easily recognise this template | |
| 36 | +| **Insights required** | A list of required Insights. See the full list <a href="/data/insights/insights" target="_blank">**here**</a>. | |
| 37 | +| **Output format** | Format in which you need the output — currently only `JSON` is supported |
| 38 | +<br /> |
| 39 | + |
| 40 | +Setu will create a template for you and share a `templateID`, which can be used |
| 41 | +in the API calls. |
| 42 | + |
| 43 | +<hr className="primary" /> |
| 44 | + |
| 45 | +### Step 2—Feed data |
| 46 | + |
| 47 | +Once you have the financial data of a user, you can feed this data into Setu Insights as a FI Data block. A `dataId` is assigned to to every FI Data block that is created. Refer <a href="/data/insights/quickstart/api-integration" target="_blank">API integration</a> to integrate with Data ingestion APIs. |
| 48 | + |
| 49 | +<hr className="primary" /> |
| 50 | + |
| 51 | +### Step 3—Generate insights |
| 52 | + |
| 53 | +You can generate insights for each FI Data block that is created in the previous step. To generate insights, pass the `templateId` and `dataId` from the previous steps. |
| 54 | + |
| 55 | +An insight report is idenitified by a `reportId` and will be sent to you asynchronously on the notification URL you provide. You can also fetch a generated insight with the `reportId` at any point. Refer <a href="/data/insights/quickstart/api-integration" target="_blank">API integration</a> to integrate with Insight generation APIs. |
| 56 | + |
| 57 | +<hr className="primary" /> |
| 58 | + |
| 59 | +## Test on Postman or integrate APIs |
| 60 | + |
| 61 | +If you are getting started with the integration, we recommend that you familiarise yourself with setting up Postman and configuring **credentials**. If you have already completed this step, you can integrate with the Setu Insights APIs directly. |
| 62 | + |
| 63 | +<Row> |
| 64 | + <Portion desktopSpan="half"> |
| 65 | + <Card padding="small" shape="rounded"> |
| 66 | + <p>ON POSTMAN</p> |
| 67 | + <a href="/data/insights/quickstart/postman" target="_blank"> |
| 68 | + Set up Postman environment -> |
| 69 | + </a> |
| 70 | + </Card> |
| 71 | + </Portion> |
| 72 | + <Portion desktopSpan="half"> |
| 73 | + <Card padding="small" shape="rounded"> |
| 74 | + <p>FOR API INTEGRATION</p> |
| 75 | + <a |
| 76 | + href="/data/insights/quickstart/api-integration" |
| 77 | + target="_blank" |
| 78 | + > |
| 79 | + Start API integration -> |
| 80 | + </a> |
| 81 | + </Card> |
| 82 | + </Portion> |
| 83 | +</Row> |
| 84 | + |
| 85 | +<WasPageHelpful /> |
0 commit comments