# Data Connectors

Source: https://opvs.ai/docs/api/data-connectors

## `GET` /api/v1/brands/{brand_id}/connectors

**List Connectors**

**Parameters**

- `brand_id` (path, integer, required)

```bash
curl -X GET 'https://app.opvs.ai/api/v1/brands/{brand_id}/connectors' \
  -H 'Authorization: Bearer <token>'
```

```python
import httpx

resp = httpx.get(
    "https://app.opvs.ai/api/v1/brands/{brand_id}/connectors",
    headers={"Authorization": "Bearer <token>"},
)
resp.raise_for_status()
print(resp.json())
```

```javascript
const resp = await fetch("https://app.opvs.ai/api/v1/brands/{brand_id}/connectors", {
  method: "GET",
  headers: { "Authorization": "Bearer <token>" }
});
const data = await resp.json();
console.log(data);
```

```go
package main

import (
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://app.opvs.ai/api/v1/brands/{brand_id}/connectors", nil)
	req.Header.Set("Authorization", "Bearer <token>")
	resp, _ := http.DefaultClient.Do(req)
	defer resp.Body.Close()
}
```

**Responses**

- `200` — Successful Response
- `422` — Validation Error

## `POST` /api/v1/brands/{brand_id}/connectors

**Create Connector**

**Parameters**

- `brand_id` (path, integer, required)

**Request body**

```bash
curl -X POST 'https://app.opvs.ai/api/v1/brands/{brand_id}/connectors' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "string"
}'
```

```python
import httpx

resp = httpx.post(
    "https://app.opvs.ai/api/v1/brands/{brand_id}/connectors",
    headers={"Authorization": "Bearer <token>", "Content-Type": "application/json"},
    json={"name": "string"},
)
resp.raise_for_status()
print(resp.json())
```

```javascript
const resp = await fetch("https://app.opvs.ai/api/v1/brands/{brand_id}/connectors", {
  method: "POST",
  headers: { "Authorization": "Bearer <token>", "Content-Type": "application/json" },
  body: JSON.stringify({"name": "string"})
});
const data = await resp.json();
console.log(data);
```

```go
package main

import (
	"net/http"
	"strings"
)

func main() {
	body := strings.NewReader(`{"name": "string"}`)
	req, _ := http.NewRequest("POST", "https://app.opvs.ai/api/v1/brands/{brand_id}/connectors", body)
	req.Header.Set("Authorization", "Bearer <token>")
	req.Header.Set("Content-Type", "application/json")
	resp, _ := http.DefaultClient.Do(req)
	defer resp.Body.Close()
}
```

**Responses**

- `201` — Successful Response
- `422` — Validation Error

## `POST` /api/v1/connectors/{connector_id}/revoke

**Revoke Connector**

**Parameters**

- `connector_id` (path, string, required)

```bash
curl -X POST 'https://app.opvs.ai/api/v1/connectors/{connector_id}/revoke' \
  -H 'Authorization: Bearer <token>'
```

```python
import httpx

resp = httpx.post(
    "https://app.opvs.ai/api/v1/connectors/{connector_id}/revoke",
    headers={"Authorization": "Bearer <token>"},
)
resp.raise_for_status()
print(resp.json())
```

```javascript
const resp = await fetch("https://app.opvs.ai/api/v1/connectors/{connector_id}/revoke", {
  method: "POST",
  headers: { "Authorization": "Bearer <token>" }
});
const data = await resp.json();
console.log(data);
```

```go
package main

import (
	"net/http"
)

func main() {
	req, _ := http.NewRequest("POST", "https://app.opvs.ai/api/v1/connectors/{connector_id}/revoke", nil)
	req.Header.Set("Authorization", "Bearer <token>")
	resp, _ := http.DefaultClient.Do(req)
	defer resp.Body.Close()
}
```

**Responses**

- `200` — Successful Response
- `422` — Validation Error

## `GET` /api/v1/connectors/jobs

**Poll Connector Jobs**

Long-poll one job.  A connector can only claim its own brand/id rows.

**Parameters**

- `wait_seconds` (query, number, optional)
- `x-opvs-connector-version` (header, any, optional)

```bash
curl -X GET 'https://app.opvs.ai/api/v1/connectors/jobs' \
  -H 'Authorization: Bearer <token>'
```

```python
import httpx

resp = httpx.get(
    "https://app.opvs.ai/api/v1/connectors/jobs",
    headers={"Authorization": "Bearer <token>"},
)
resp.raise_for_status()
print(resp.json())
```

```javascript
const resp = await fetch("https://app.opvs.ai/api/v1/connectors/jobs", {
  method: "GET",
  headers: { "Authorization": "Bearer <token>" }
});
const data = await resp.json();
console.log(data);
```

```go
package main

import (
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://app.opvs.ai/api/v1/connectors/jobs", nil)
	req.Header.Set("Authorization", "Bearer <token>")
	resp, _ := http.DefaultClient.Do(req)
	defer resp.Body.Close()
}
```

**Responses**

- `200` — Successful Response
- `422` — Validation Error

## `POST` /api/v1/connectors/jobs/{job_id}/result

**Post Connector Result**

**Parameters**

- `job_id` (path, string, required)

**Request body**

```bash
curl -X POST 'https://app.opvs.ai/api/v1/connectors/jobs/{job_id}/result' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "rows": [
    {}
  ],
  "masked": 0,
  "duration_ms": 0,
  "error_code": "string"
}'
```

```python
import httpx

resp = httpx.post(
    "https://app.opvs.ai/api/v1/connectors/jobs/{job_id}/result",
    headers={"Authorization": "Bearer <token>", "Content-Type": "application/json"},
    json={"rows": [{}], "masked": 0, "duration_ms": 0, "error_code": "string"},
)
resp.raise_for_status()
print(resp.json())
```

```javascript
const resp = await fetch("https://app.opvs.ai/api/v1/connectors/jobs/{job_id}/result", {
  method: "POST",
  headers: { "Authorization": "Bearer <token>", "Content-Type": "application/json" },
  body: JSON.stringify({"rows": [{}], "masked": 0, "duration_ms": 0, "error_code": "string"})
});
const data = await resp.json();
console.log(data);
```

```go
package main

import (
	"net/http"
	"strings"
)

func main() {
	body := strings.NewReader(`{"rows": [{}], "masked": 0, "duration_ms": 0, "error_code": "string"}`)
	req, _ := http.NewRequest("POST", "https://app.opvs.ai/api/v1/connectors/jobs/{job_id}/result", body)
	req.Header.Set("Authorization", "Bearer <token>")
	req.Header.Set("Content-Type", "application/json")
	resp, _ := http.DefaultClient.Do(req)
	defer resp.Body.Close()
}
```

**Responses**

- `202` — Successful Response
- `422` — Validation Error

## List Connectors

`GET https://app.opvs.ai/api/v1/brands/{brand_id}/connectors`

| Code | When | What to do |
| --- | --- | --- |
| 422 | Validation Error |  |

## Create Connector

`POST https://app.opvs.ai/api/v1/brands/{brand_id}/connectors`

| Code | When | What to do |
| --- | --- | --- |
| 422 | Validation Error |  |

## Revoke Connector

`POST https://app.opvs.ai/api/v1/connectors/{connector_id}/revoke`

| Code | When | What to do |
| --- | --- | --- |
| 422 | Validation Error |  |

## Poll Connector Jobs

`GET https://app.opvs.ai/api/v1/connectors/jobs`

Long-poll one job.  A connector can only claim its own brand/id rows.

| Code | When | What to do |
| --- | --- | --- |
| 422 | Validation Error |  |

## Post Connector Result

`POST https://app.opvs.ai/api/v1/connectors/jobs/{job_id}/result`

| Code | When | What to do |
| --- | --- | --- |
| 422 | Validation Error |  |