@synterai/sdk-js 0.1.0 → 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +5 -8
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
TypeScript SDK for the [Synter](https://syntermedia.ai) advertising API — manage campaigns across Google Ads, Meta, LinkedIn, Microsoft Ads, Reddit, TikTok, and X from your own code, with full types and IDE autocomplete.
|
|
4
4
|
|
|
5
|
-
>
|
|
5
|
+
> **`0.1.0` — early release.** Live on npm and installable, but pre-1.0: the surface may change before a stable `1.0`. Pin a version in production.
|
|
6
6
|
|
|
7
7
|
## What this actually talks to
|
|
8
8
|
|
|
@@ -10,21 +10,18 @@ Every method in this SDK calls the same live, production endpoint that powers Sy
|
|
|
10
10
|
|
|
11
11
|
See [`../sdk-shared/SPEC.md`](../sdk-shared/SPEC.md) and [`../sdk-shared/catalog.json`](../sdk-shared/catalog.json) for the full transport contract this SDK — and every sibling-language SDK — implements.
|
|
12
12
|
|
|
13
|
-
## Install
|
|
13
|
+
## Install
|
|
14
14
|
|
|
15
15
|
```bash
|
|
16
|
-
|
|
17
|
-
cd synter-media/packages/sdk-js
|
|
18
|
-
npm install
|
|
19
|
-
npm run build
|
|
16
|
+
npm install @synterai/sdk-js
|
|
20
17
|
```
|
|
21
18
|
|
|
22
|
-
Then depend on it locally (e.g. `npm install ../path/to/synter-media/packages/sdk-js` or a workspace reference) until it's published.
|
|
23
|
-
|
|
24
19
|
## Authentication
|
|
25
20
|
|
|
26
21
|
Get an API key at [syntermedia.ai/developer](https://syntermedia.ai/developer). Keys look like `syn_` followed by 32 base64url characters.
|
|
27
22
|
|
|
23
|
+
> **⚠️ Server-side only.** Your `SYNTER_API_KEY` is a secret that can spend money and modify your ad accounts. Use this SDK from a **backend** — a Node service, a Next.js API route or Server Action, an edge/serverless function. **Never** instantiate `Synter` in client-side code (React components, browser bundles, mobile apps); the key would ship to every visitor. For a React/SPA frontend, call your own backend, and have the backend call Synter.
|
|
24
|
+
|
|
28
25
|
```ts
|
|
29
26
|
import { Synter } from '@synterai/sdk-js';
|
|
30
27
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@synterai/sdk-js",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.1",
|
|
4
4
|
"description": "TypeScript SDK for the Synter advertising API — manage campaigns across Google Ads, Meta, LinkedIn, Reddit, Microsoft, TikTok, and X",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"module": "dist/index.mjs",
|