Documentation Index
Fetch the complete documentation index at: https://docs.s4kit.com/llms.txt
Use this file to discover all available pages before exploring further.
Overview
Services in S4Kit represent SAP OData APIs. The platform includes a catalog of 500+ predefined SAP services, and you can add custom services for your own OData endpoints.
Service Catalog
S4Kit includes predefined services from the SAP API Business Hub:
Common Services
| Service | Description |
|---|
API_BUSINESS_PARTNER | Business Partner master data |
API_SALES_ORDER_SRV | Sales Order operations |
API_PURCHASEORDER_PROCESS_SRV | Purchase Order processing |
API_MATERIAL_STOCK_SRV | Material stock information |
API_PRODUCT_SRV | Product master data |
API_BILLING_DOCUMENT_SRV | Billing documents |
Browsing Services
- Navigate to Services in the dashboard
- Use search to find services
- Filter by category (Sales, Procurement, Finance, etc.)
- Click a service to see details
Binding Services
To use a service, you must bind it to a system or instance.
System-Level Binding
Bind a service to all instances of a system:
- Go to Systems → Select your system
- Click Add Service
- Search and select the service
- Configure service-level authentication (optional)
- Click Bind
Instance-Level Binding
Bind a service to a specific instance with custom configuration:
- Go to Instances → Select your instance
- Click Add Service
- Search and select the service
- Configure authentication overrides (optional)
- Click Bind
Service Configuration
Service Path
Each service has a default OData path:
/sap/opu/odata/sap/API_BUSINESS_PARTNER
/custom/odata/v4/my-service
Authentication Override
Override authentication for specific services:
Instance Auth → System Service Auth → Instance Service Auth
Custom Services
Add your own OData services:
- Click Add Custom Service
- Fill in service details:
| Field | Description | Example |
|---|
| Name | Service name | ”Custom Inventory API” |
| Technical Name | OData service name | ”Z_INVENTORY_SRV” |
| Path | OData endpoint path | ”/sap/opu/odata/sap/Z_INVENTORY_SRV” |
| Version | OData version | ”V2” or “V4” |
| Description | Service description | ”Custom inventory management” |
Service Permissions
When creating API keys, you can grant permissions per service and entity:
API_BUSINESS_PARTNER
├── A_BusinessPartner: read, write
├── A_BusinessPartnerAddress: read
└── A_BusinessPartnerBank: none
API_SALES_ORDER_SRV
├── A_SalesOrder: read, write
└── A_SalesOrderItem: read, write
Using Services
Default Service Resolution
The SDK automatically resolves services based on entity names:
// SDK determines service from entity name
const partners = await client.A_BusinessPartner.list();
// → Uses API_BUSINESS_PARTNER service
Explicit Service
Specify a service explicitly:
const orders = await client.A_SalesOrder.list({
service: 'API_SALES_ORDER_SRV'
});
Multiple Services with Same Entity
If multiple services expose the same entity:
// Use service option to specify which
const products = await client.A_Product.list({
service: 'API_PRODUCT_SRV'
});
// Or configure a default in the client
const client = new S4Kit({
apiKey: 'sk_live_...',
service: 'API_PRODUCT_SRV'
});
OData Versions
S4Kit supports both OData V2 and V4:
| Version | Description |
|---|
| V2 | Classic SAP OData format |
| V4 | Modern OData standard |
- Click on a bound service
- View the Metadata tab
- See available:
- Entity sets
- Entity types with properties
- Navigation properties
- Function imports
- Action imports
Troubleshooting
Service Not Found
Error: Service 'API_BUSINESS_PARTNER' not found
- Ensure the service is bound to your instance
- Check that your API key has access to the service
- Verify the service path is correct
Entity Not Found
Error: Entity 'A_BusinessPartner' not found in service
- The entity name may be different—check metadata
- The service might not expose this entity
- Try a different service
Authentication Failed
Error: 401 Unauthorized for service
- Verify authentication configuration
- Check credentials are correct
- Ensure the SAP user has access to the service
