Skip to content

Commit

Permalink
docs: add http api page
Browse files Browse the repository at this point in the history
Signed-off-by: Kenta Kozuka <[email protected]>
  • Loading branch information
kentakozuka committed Jun 20, 2024
1 parent 702bc71 commit ced6bc2
Show file tree
Hide file tree
Showing 4 changed files with 42 additions and 0 deletions.
3 changes: 3 additions & 0 deletions docs/feature-flags/api-keys.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,9 @@ The API key has 2 roles.

- **Client SDK:** Allows all SDKs to evaluate end users on the Bucketeer server.
- **Server SDK:** Allows the server SDK (Golang) to evaluate end users locally within the SDK.
- **Public API(Read Only):** This role allows you to read the data in Bucketeer.
- **Public API(Read and Write):** This role allows you to read and write the data in Bucketeer.
- **Public API(Admin):** This role allows you to read and write the data including admin settings in Bucketeer.

To generate a new API key, click the **+ Add** button on the **API Keys** page.<br />

Expand Down
33 changes: 33 additions & 0 deletions docs/integration/http-api.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
title: Bucketeer HTTP API
sidebar_position: 2
slug: /integration/http-api
---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import CenteredImg from '@site/src/components/centered-img/CenteredImg';

:::caution HTTP API (Alpha)

The HTTP API is currently in its alpha stage.

If you find any issues or have suggestions for improvement, feel free to open an [issue](https://github.com/bucketeer-io/bucketeer/issues).<br />
All contributions are welcome!

:::

The Bucketeer HTTP API allows you to interact with the Bucketeer service programmatically. It supports operations such as creating, updating, and retrieving feature flags, managing users, and evaluating feature flags for specific users.

## Authentication
Bucketeer API uses token-based authentication. Each request must include an `authorization` header with the token:
```http
authorization: <your-api-key>
```

[API Key](/feature-flags/api-keys) can be created in the Bucketeer dashboard.

## API specification

API specification is available [here](https://github.com/bucketeer-io/bucketeer/blob/main/api-description/service.swagger.json).

5 changes: 5 additions & 0 deletions docs/integration/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,8 @@ This section provides essential information for utilizing Bucketeer integration
## Notifications

Bucketeer provide dashboard [Notifications](/integration/notifications) to alert you and your team regarding changes or events on the dashboard.

## HTTP API

Bucketeer provide [HTTP API](/integration/http-api) to enable you to read and write data from Bucketeer programmatically.
```
1 change: 1 addition & 0 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -210,6 +210,7 @@ const sidebars = {
items: [
'integration/pushes',
'integration/notifications',
'integration/http-api',
],
},

Expand Down

0 comments on commit ced6bc2

Please sign in to comment.