mirror of
https://github.com/agentrhq/authsome.git
synced 2026-09-19 01:34:19 +08:00
Manoj Bajaj
cac5f9f2c4
Remove references to five pages that do not exist: reference/provider-schema, reference/file-layout, concepts/profiles-vs-connections, security/hosted-deployment, guides/profiles. Strategy: strip the links/sentences from the 59 source files rather than creating stub pages. Card blocks pointing to missing pages are removed; inline sentence references are removed or reworded so the surrounding prose stays coherent. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
104 lines
2.9 KiB
Plaintext
104 lines
2.9 KiB
Plaintext
---
|
|
title: "Rewardful"
|
|
sidebarTitle: "Rewardful"
|
|
description: "Store and use your Rewardful API key with authsome. Local encrypted vault, proxy injection, no key in the agent's environment."
|
|
keywords: ["rewardful api key authsome", "rewardful key broker", "rewardful agent credentials", "authsome rewardful"]
|
|
---
|
|
|
|
import MultiConnectionsCta from "/snippets/multi-connections-cta.mdx";
|
|
import MaskedInputNote from "/snippets/masked-input-note.mdx";
|
|
import WhatsNextApiKey from "/snippets/whats-next-apikey.mdx";
|
|
|
|
Rewardful uses a long-lived API key. Authsome stores the key encrypted in the local vault, injects it at request time through the proxy, and keeps it out of shell history, process listings, and environment dumps.
|
|
|
|
## At a glance
|
|
|
|
| | |
|
|
|---|---|
|
|
| Provider name | `rewardful` |
|
|
| Display name | Rewardful |
|
|
| Auth type | API key |
|
|
| Header | `Authorization: Bearer <key>` |
|
|
| Proxy host | `api.getrewardful.com` |
|
|
| Env var | `REWARDFUL_API_KEY` |
|
|
| Where to get a key | [https://app.getrewardful.com/company/api-keys](https://app.getrewardful.com/company/api-keys) |
|
|
|
|
## Get a key
|
|
|
|
Create an API key in the Rewardful dashboard at [https://app.getrewardful.com/company/api-keys](https://app.getrewardful.com/company/api-keys).
|
|
|
|
## Log in
|
|
|
|
```bash
|
|
authsome login rewardful
|
|
```
|
|
|
|
A local browser form opens at `http://127.0.0.1:7998`. Paste the key into the masked input and submit.
|
|
|
|
<MaskedInputNote />
|
|
|
|
Verify:
|
|
|
|
```bash
|
|
authsome get rewardful --field status
|
|
# → connected
|
|
```
|
|
|
|
## Use the key
|
|
|
|
Run the agent under the proxy. The library tab is for embedding authsome inside a larger Python orchestrator.
|
|
|
|
<CodeGroup>
|
|
|
|
```bash Proxy (recommended)
|
|
authsome run -- python my_agent.py
|
|
```
|
|
|
|
```bash Environment
|
|
eval "$(authsome export rewardful --format env)"
|
|
echo $REWARDFUL_API_KEY
|
|
```
|
|
|
|
```python Python library
|
|
from authsome.server.dependencies import create_auth_service
|
|
|
|
auth = create_auth_service()
|
|
key = auth.get_access_token("rewardful", connection="default")
|
|
```
|
|
|
|
</CodeGroup>
|
|
|
|
Under the proxy, authsome sets `REWARDFUL_API_KEY=authsome-proxy-managed` in the child's environment and injects the real key into outbound requests to `api.getrewardful.com`. The child process never sees the actual value.
|
|
|
|
## Multiple keys
|
|
|
|
<MultiConnectionsCta />
|
|
|
|
```bash
|
|
authsome login rewardful --connection personal
|
|
authsome login rewardful --connection team
|
|
```
|
|
|
|
## Rotate or remove the key
|
|
|
|
```bash
|
|
authsome login rewardful --force # rotate
|
|
authsome logout rewardful # remove local credential
|
|
authsome remove rewardful # remove all local state for the provider
|
|
```
|
|
|
|
API-key providers have no revocation endpoint, so `revoke` and `remove` are equivalent for Rewardful.
|
|
|
|
## Override the bundled definition
|
|
|
|
```bash
|
|
authsome inspect rewardful > ~/.authsome/providers/rewardful.json
|
|
# edit fields
|
|
authsome list # source now shows "custom" for rewardful
|
|
```
|
|
|
|
|
|
## What's next
|
|
|
|
<WhatsNextApiKey />
|