mirror of
https://github.com/formbricks/formbricks.git
synced 2026-02-07 03:08:43 -06:00
7fa2a260e8
* add @formbricks/api (api abstraction layer) and @formbricks/errors package to monorepo * use @formbricks/api in @formbricks/js to expose an api endpoint --------- Co-authored-by: Matthias Nannt <mail@matthiasnannt.com>
56 lines
1014 B
Markdown
56 lines
1014 B
Markdown
# @formbricks/api - API Wrapper for Formbricks
|
|
|
|
## Installation
|
|
|
|
```bash
|
|
npm install @formbricks/api
|
|
```
|
|
|
|
## Usage
|
|
|
|
<details>
|
|
<summary>Create API Client</summary>
|
|
|
|
```ts
|
|
import { FormbricksAPI, EnvironmentId } from "@formbricks/api";
|
|
|
|
const api = new FormbricksAPI({
|
|
apiHost: "http://localhost:3000",
|
|
environmentId: "clgwh8maj0005n2f66pwzev3r" as EnvironmentId,
|
|
});
|
|
```
|
|
|
|
</details>
|
|
|
|
> **Note**
|
|
> All of the following methods return a `Result` from the `@formbricks/errors` package.
|
|
|
|
<details>
|
|
<summary>Create a new response</summary>
|
|
|
|
```ts
|
|
const response = await api.createResponse({
|
|
surveyId: "......" as SurveyId,
|
|
personId: "......" as PersonId,
|
|
data: {
|
|
questionId: "response",
|
|
},
|
|
});
|
|
```
|
|
|
|
</details>
|
|
|
|
<details>
|
|
<summary>Update an existing response</summary>
|
|
|
|
```ts
|
|
const response = await api.updateResponse({
|
|
responseId: "......" as ResponseId, // If you pass response.value.id from createResponse, you dont need 'as ResponseId'
|
|
data: {
|
|
questionId: "response",
|
|
},
|
|
});
|
|
```
|
|
|
|
</details>
|