docs: explain API key provisioning

This commit is contained in:
Mo Elzubeir
2026-05-29 14:47:41 -05:00
parent 57b1a67c2e
commit b33fd01182
4 changed files with 44 additions and 0 deletions
+6
View File
@@ -10,6 +10,12 @@ Future SDKs can live beside it, e.g. `sdks/python`, `sdks/go`, or `sdks/php`.
## JavaScript / TypeScript ## JavaScript / TypeScript
API keys are provisioned by Socialhose or your account administrator. Set the key server-side before using the SDK:
```bash
export SOCIALHOSE_API_KEY="sh_your_key_here"
```
```bash ```bash
npm install @socialhose/api npm install @socialhose/api
``` ```
+24
View File
@@ -28,6 +28,30 @@ Use `@socialhose/api` from server-side JavaScript/TypeScript to build:
This package is intended for **backend code only**. Do not ship your Socialhose API key to browsers. This package is intended for **backend code only**. Do not ship your Socialhose API key to browsers.
## Getting an API key
API keys are issued by Socialhose. The SDK does not create keys, and there is no self-service key-generation flow documented in this package.
To use the SDK:
1. Request Socialhose Public API access from the Socialhose team or your account administrator.
2. Ask for an API key with access to the campaigns you need to query.
3. Store it as a server-side environment variable:
```bash
export SOCIALHOSE_API_KEY="sh_your_key_here"
```
4. Pass it to the client:
```ts
const socialhose = new SocialhoseClient({
apiKey: process.env.SOCIALHOSE_API_KEY!,
});
```
Do not commit API keys, expose them in frontend bundles, or send them to browsers. If you are building a web app, call Socialhose from your server/API route and return only the data your frontend needs.
## Install ## Install
```bash ```bash
+2
View File
@@ -66,6 +66,8 @@ Type exports:
## Authentication ## Authentication
Socialhose API keys are provisioned by Socialhose or by your account administrator. This SDK consumes an existing key; it does not create or manage keys.
Every request sends: Every request sends:
- `Authorization: Api-Key <apiKey>` - `Authorization: Api-Key <apiKey>`
+12
View File
@@ -20,6 +20,18 @@ npm install @socialhose/api
Requires Node 18+ or a custom `fetch` implementation. Requires Node 18+ or a custom `fetch` implementation.
## Getting API access
Socialhose API keys are provisioned by Socialhose. This SDK only consumes an existing key; it cannot create, rotate, or discover keys for you.
Ask the Socialhose team or your account administrator for a Public API key and confirm which campaigns it can access. Then set it in your server environment:
```bash
export SOCIALHOSE_API_KEY="sh_your_key_here"
```
Keep this value server-side. For browser applications, create your own backend endpoint that uses this SDK and returns sanitized data to the frontend.
## Basic setup ## Basic setup
```ts ```ts