Services

​

Overview

​

Service Catalog

​

Common Services

​

Browsing Services

1. Navigate to Services in the dashboard
2. Use search to find services
3. Filter by category (Sales, Procurement, Finance, etc.)
4. Click a service to see details

​

Binding Services

​

System-Level Binding

1. Go to Systems → Select your system
2. Click Add Service
3. Search and select the service
4. Configure service-level authentication (optional)
5. Click Bind

​

Instance-Level Binding

1. Go to Instances → Select your instance
2. Click Add Service
3. Search and select the service
4. Configure authentication overrides (optional)
5. Click Bind

​

Service Configuration

​

Service Path

/sap/opu/odata/sap/API_BUSINESS_PARTNER

/custom/odata/v4/my-service

​

Authentication Override

Instance Auth → System Service Auth → Instance Service Auth

​

Custom Services

1. Click Add Custom Service
2. Fill in service details:

​

Service Permissions

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

// SDK determines service from entity name
const partners = await client.A_BusinessPartner.list();
// → Uses API_BUSINESS_PARTNER service

​

Explicit Service

const orders = await client.A_SalesOrder.list({
  service: 'API_SALES_ORDER_SRV'
});

​

Multiple Services with 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

​

Service Metadata

1. Click on a bound service
2. View the Metadata tab
3. 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