s4kit 0.1.11 → 0.1.12
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 +4 -4
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -8,7 +8,7 @@ Type-safe SDK for consuming SAP APIs. Build Clean Core applications faster.
|
|
|
8
8
|
|
|
9
9
|
Works with Next.js, Express, Hono, Fastify, NestJS, Remix, and any Node.js framework.
|
|
10
10
|
|
|
11
|
-
[Documentation](https://docs.s4kit.com) · [Get API Key](https://
|
|
11
|
+
[Documentation](https://docs.s4kit.com) · [Get API Key](https://app.s4kit.com) · [Examples](./examples/)
|
|
12
12
|
|
|
13
13
|
```bash
|
|
14
14
|
npm install s4kit # or yarn add s4kit / pnpm add s4kit / bun add s4kit
|
|
@@ -34,7 +34,7 @@ const partners = await client.A_BusinessPartner.list({
|
|
|
34
34
|
| Option | Type | Default | Description |
|
|
35
35
|
|--------|------|---------|-------------|
|
|
36
36
|
| `apiKey` | `string` | required | Your S4Kit API key |
|
|
37
|
-
| `baseUrl` | `string` | `https://
|
|
37
|
+
| `baseUrl` | `string` | `https://api.s4kit.com/api/proxy` | API endpoint |
|
|
38
38
|
| `connection` | `string` | - | Default SAP connection alias |
|
|
39
39
|
| `timeout` | `number` | `30000` | Request timeout (ms) |
|
|
40
40
|
| `retries` | `number` | `0` | Retry failed requests |
|
|
@@ -55,7 +55,7 @@ Your App → S4Kit SDK → S4Kit Platform → Your SAP System
|
|
|
55
55
|
```
|
|
56
56
|
|
|
57
57
|
**Getting started:**
|
|
58
|
-
1. Create an account at [
|
|
58
|
+
1. Create an account at [app.s4kit.com](https://app.s4kit.com)
|
|
59
59
|
2. Connect your SAP system (S/4HANA, BTP, or CAP service)
|
|
60
60
|
3. Generate an API key
|
|
61
61
|
4. Use the API key in your SDK configuration
|
|
@@ -95,7 +95,7 @@ npx s4kit generate-types --api-key sk_live_... --output ./types
|
|
|
95
95
|
npx s4kit generate-types \
|
|
96
96
|
--api-key sk_live_... # Required
|
|
97
97
|
--output ./types # Output directory (default: ./s4kit-types)
|
|
98
|
-
--base-url https://
|
|
98
|
+
--base-url https://api.s4kit.com/api/proxy # Custom proxy URL
|
|
99
99
|
--connection my-sap-system # Specific connection only
|
|
100
100
|
```
|
|
101
101
|
|