Skip to content

Commit acc0b8d

Browse files
committed
Add Generic HTTP integration documentation with interactive builder
- Created new Generic HTTP integration docs section (position 1 in custom integrations) - Added Overview page explaining when to use, how it works, and advanced configurations - Built interactive 'Build Your Integration' guide with 3 steps: - Step 1: Configure API (base URL, auth, pagination, advanced settings) - Step 2: Choose data to sync (endpoint, response, field mapping, blueprint config) - Step 3: Install and create in Port (dynamic Helm/Docker commands, blueprint JSON, mapping YAML) - Implemented React components with shared context for seamless state management - Labeled as 'Generic HTTP (New ⭐)' in sidebar to highlight new feature - Updated API integration position to 2
1 parent 2f09bb4 commit acc0b8d

19 files changed

+4512
-1
lines changed
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
{
22
"label": "API",
3-
"position": 1
3+
"position": 2
44
}
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
{
2+
"position": 1,
3+
"label": "Generic HTTP (New ⭐)",
4+
"collapsible": true,
5+
"collapsed": true,
6+
"link": {
7+
"type": "generated-index"
8+
}
9+
}
10+
11+
12+
13+
14+
15+
16+
17+
18+
19+
Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
---
2+
sidebar_position: 2
3+
title: Build Your Integration
4+
description: Interactive guide to configure and install your integration
5+
---
6+
7+
import PortApiRegionTip from "/docs/generalTemplates/_port_api_available_regions.md"
8+
import { IntegrationBuilderProvider, Step1ApiConfig, Step2DataMapping, Step3Installation } from '@site/src/components/GenericHttp';
9+
10+
# Build Your Integration
11+
12+
This interactive guide will help you generate everything you need to connect your API to Port.
13+
14+
**How it works:**
15+
1. Configure your API connection settings
16+
2. Choose an endpoint and select which fields to sync
17+
3. Get your installation commands, blueprint, and mapping configuration
18+
19+
<IntegrationBuilderProvider>
20+
21+
---
22+
23+
## Step 1: Configure Your API
24+
25+
Set up the connection details for your API:
26+
27+
<Step1ApiConfig />
28+
29+
---
30+
31+
## Step 2: Choose What Data to Sync
32+
33+
Select an endpoint and configure which fields to ingest into Port:
34+
35+
<Step2DataMapping />
36+
37+
---
38+
39+
## Step 3: Install and Create in Port
40+
41+
Use the commands and configurations generated from your selections above.
42+
43+
44+
<Step3Installation />
45+
46+
:::info Port credentials needed
47+
Get your `PORT_CLIENT_ID` and `PORT_CLIENT_SECRET` from [Port Settings → Credentials](https://app.getport.io/settings).
48+
:::
49+
50+
</IntegrationBuilderProvider>

0 commit comments

Comments
 (0)