Security News
Introducing the Socket Python SDK
The initial version of the Socket Python SDK is now on PyPI, enabling developers to more easily interact with the Socket REST API in Python projects.
@kibocommerce/rest-sdk
Advanced tools
Install package
npm install @kibocommerce/rest-sdk
Create env file (optional)
KIBO_LOCALE=
KIBO_TENANT=
KIBO_SITE=
KIBO_MASTER_CATALOG=
KIBO_CATALOG=
KIBO_CURRENCY=
KIBO_AUTH_HOST=
KIBO_CLIENT_ID=
KIBO_SHARED_SECRET=
KIBO_API_ENV=
import { Configuration } from '@kibocommerce/rest-sdk'
import { ProductSearchApi } from '@kibocommerce/rest-sdk/clients/CatalogStorefront'
const configuration = new Configuration({
tenantId: 26507,
siteId: 41315,
catalog: 1,
masterCatalog: 1,
sharedSecret: '12345_Secret',
clientId: 'KIBO_APP.1.0.0.Release',
pciHost: 'pmts.mozu.com',
authHost: 'home.mozu.com',
apiEnv: 'sandbox',
})
const client = new ProductSearchApi(configuration)
const response = await client.storefrontSearch({ query: 'shoes' })
Clients are separated by different domain and should align with the Kibo API Docs
You can find and import these under the clients
folder
import { SomeApi } from '@kibocommerce/rest-sdk/clients/*'
For example, If you are looking for APIs under the "Inventory" section of the documentation you can find the related Api clients under '@kibocommerce/rest-sdk/clients/Inventory'
import { InventoryApi } from '@kibocommerce/rest-sdk/clients/Inventory'
const client = new InventoryApi(config)
const resp = await client.getInventory({ items: [{ upc: '1234' }] })
import 'dotenv/config'
import { Configuration } from '@kibocommerce/rest-sdk'
import { ProductSearchApi } from '@kibocommerce/rest-sdk/clients/CatalogStorefront'
// create a configuration object from ENV variables (note: you must load env variables yourself)
const configuration = Configuration.fromEnv()
// create new api client instance with configuration
const client = new ProductSearchApi(configuration)
// perform api calls
const response = await client.storefrontSearch({ query: 'shoes' })
Every API client supports custom middleware that can execute before and after request execution and on any error during the request.
Define a class that implements the Middleware interface and provide to the configuration object.
Example use case would be request logging
// LoggerMiddleware.ts
import {
Middleware,
RequestContext,
ResponseContext,
FetchParams,
ErrorContext,
} from '@kibocommerce/rest-sdk/types'
export class LoggerMiddleware implements Middleware {
public async pre(context: RequestContext): Promise<FetchParams | void> {
console.log(`sending METHOD: ${context.init.method} URL: ${context.url}`)
}
public async post(context: ResponseContext): Promise<Response | void> {
console.log(`response STATUS: ${context.response.status}`)
}
public async onError(context: ErrorContext): Promise<Response | void> {
console.error('logging error', context.error)
}
}
import { Configuration } from '@kibocommerce/rest-sdk'
import { ProductSearchApi } from '@kibocommerce/rest-sdk/clients/CatalogStorefront'
const loggerMiddleware = new LoggerMiddleware()
const configuration = new Configuration({
tenantId: 26507,
siteId: 41315,
catalog: 1,
masterCatalog: 1,
sharedSecret: '12345_Secret',
clientId: 'KIBO_APP.1.0.0.Release',
pciHost: 'pmts.mozu.com',
authHost: 'home.mozu.com',
apiEnv: 'sandbox',
middleware: [loggerMiddleware],
})
const client = new ProductSearchApi(configuration)
Middleware can also be added after an Api client has been created
import { Configuration } from '@kibocommerce/rest-sdk'
import { ProductSearchApi } from '@kibocommerce/rest-sdk/clients/CatalogStorefront'
const loggerMiddleware = new LoggerMiddleware()
const client = new ProductSearchApi(configuration)
client.withMiddleware([loggerMiddleware])
FAQs
Kibo Commerce Rest client SDK
The npm package @kibocommerce/rest-sdk receives a total of 194 weekly downloads. As such, @kibocommerce/rest-sdk popularity was classified as not popular.
We found that @kibocommerce/rest-sdk demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
The initial version of the Socket Python SDK is now on PyPI, enabling developers to more easily interact with the Socket REST API in Python projects.
Security News
Floating dependency ranges in npm can introduce instability and security risks into your project by allowing unverified or incompatible versions to be installed automatically, leading to unpredictable behavior and potential conflicts.
Security News
A new Rust RFC proposes "Trusted Publishing" for Crates.io, introducing short-lived access tokens via OIDC to improve security and reduce risks associated with long-lived API tokens.