Skip to content

Commit e381dfd

Browse files
authored
Merge pull request #2972 from port-labs/feature/rename-docs-to-ocean-custom
Feature/rename docs to ocean custom
2 parents 2c3818d + 526fab8 commit e381dfd

21 files changed

+4591
-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: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
{
2+
"position": 1,
3+
"label": "Ocean custom integration",
4+
"collapsible": true,
5+
"collapsed": true
6+
}
7+
8+
9+
10+
11+
12+
13+
14+
15+
16+
Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
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/OceanCustom';
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. These settings apply globally to all endpoints you'll sync from this API.
26+
27+
**What you're configuring:**
28+
- **Base URL**: The root URL that all endpoint paths will be appended to
29+
- **Authentication**: How your API verifies requests (bearer token, API key, basic auth, or none)
30+
- **Pagination** (optional): How to fetch data across multiple pages if your API uses pagination
31+
- **Performance settings** (optional): Timeouts, concurrent requests, SSL verification
32+
33+
Think of this as setting up the "connection" - these settings will be used for every API call the integration makes.
34+
35+
<Step1ApiConfig />
36+
37+
---
38+
39+
## Step 2: Choose what data to sync
40+
41+
Now that your API connection is configured, let's define what data to sync. This step helps you map a specific API endpoint to a Port blueprint.
42+
43+
**What you'll do:**
44+
1. **Specify the endpoint path** (e.g., `/api/v1/users`) that you want to sync
45+
2. **Paste a sample API response** so we can detect the data structure
46+
3. **Select the data path** - tell us where the array of items is in the response (e.g., `.data`, `.users`, or root array)
47+
4. **Configure the blueprint** - give it an identifier and title
48+
5. **Choose which fields to sync** - select the fields you want to ingest and mark which field is the unique identifier
49+
50+
The builder will automatically detect field types (string, number, boolean, email, date, URL) from your sample response.
51+
52+
<Step2DataMapping />
53+
54+
---
55+
56+
## Step 3: Install and create in Port
57+
58+
You're all set! Based on your configuration, we've generated everything you need:
59+
60+
**What you'll get:**
61+
- **Installation commands** (Helm or Docker) with all your settings pre-configured
62+
- **Blueprint JSON** to create the data model in Port
63+
- **Mapping YAML** to configure which fields to sync
64+
65+
Simply copy and run these in order to complete your integration setup.
66+
67+
<Step3Installation />
68+
69+
:::info Port credentials needed
70+
Get your `PORT_CLIENT_ID` and `PORT_CLIENT_SECRET` from [Port Settings → Credentials](https://app.getport.io/settings).
71+
:::
72+
73+
</IntegrationBuilderProvider>

0 commit comments

Comments
 (0)