5.13.0 • Published 9 months ago
@commercetools/importapi-sdk v5.13.0
TypeScript SDK for commercetools Composable Commerce Import API
Usage examples
Browser environment
<script src="https://unpkg.com/@commercetools/sdk-client-v2@latest/dist/commercetools-sdk-client-v2.umd.js"></script>
<script src="https://unpkg.com/@commercetools/importapi-sdk@latest/dist/commercetools-importapi-sdk.umd.js"></script>
<script>
// global: @commercetools/sdk-client-v2
// global: @commercetools/importapi-sdk
;(function () {
// We can now access the sdk-client-v2 and importapi-sdk object as:
// const { ClientBuilder } = this['@commercetools/sdk-client-v2']
// const { createApiBuilderFromCtpClient } = this['@commercetools/importapi-sdk']
// or
// const { ClientBuilder } = window['@commercetools/sdk-client-v2']
// const { createApiBuilderFromCtpClient } = window['@commercetools/importapi-sdk']
})()
</script>
Node environment
npm install --save @commercetools/sdk-client-v2
npm install --save @commercetools/importapi-sdk
const {
ClientBuilder,
createAuthForClientCredentialsFlow,
createHttpClient,
} = require('@commercetools/sdk-client-v2')
const { createApiBuilderFromCtpClient } = require('@commercetools/importapi-sdk')
const fetch = require('node-fetch')
const projectKey = 'mc-project-key'
const authMiddlewareOptions = {
host: 'https://auth.europe-west1.gcp.commercetools.com',
projectKey,
credentials: {
clientId: 'mc-client-id',
clientSecret: 'mc-client-secrets',
},
oauthUri: '/oauth/token', // - optional: custom oauthUri
scopes: [`manage_project:${projectKey}`],
fetch,
}
const httpMiddlewareOptions = {
host: 'https://import.europe-west1.gcp.commercetools.com',
fetch,
}
const client = new ClientBuilder()
.withProjectKey(projectKey)
.withMiddleware(createAuthForClientCredentialsFlow(authMiddlewareOptions))
.withMiddleware(createHttpClient(httpMiddlewareOptions))
.withUserAgentMiddleware()
.build()
// or
const client = new ClientBuilder()
.withProjectKey(projectKey)
.withClientCredentialsFlow(authMiddlewareOptions)
.withHttpMiddleware(httpMiddlewareOptions)
.withUserAgentMiddleware()
.build()
const apiRoot = createApiBuilderFromCtpClient(client)
// calling the importapi functions
// get project details
apiRoot
.withProjectKeyValue({
projectKey,
})
.importContainers()
.get()
.execute()
.then((x) => {
/*...*/
})
// -----------------------------------------------------------------------
// The sdk-client-v2 also has support for the old syntax
import {
createClient,
createHttpClient,
createAuthForClientCredentialsFlow,
} from '@commercetools/sdk-client-v2'
import { createApiBuilderFromCtpClient } from '@commercetools/importapi-sdk')
import fetch from 'node-fetch'
const projectKey = 'some_project_key'
const authMiddleware = createAuthForClientCredentialsFlow({
host: 'https://auth.europe-west1.gcp.commercetools.com',
projectKey,
credentials: {
clientId: 'some_id',
clientSecret: 'some_secret',
},
fetch,
})
const httpMiddleware = createHttpClient({
host: 'https://import.europe-west1.gcp.commercetools.com',
fetch,
})
const ctpClient = createClient({
middlewares: [authMiddleware, httpMiddleware],
})
const apiRoot = createApiBuilderFromCtpClient(ctpClient)
apiRoot
.withProjectKey({
projectKey,
})
.get()
.execute()
.then((x) => {
/*...*/
})
5.13.0
9 months ago
5.11.0
10 months ago
5.12.0
10 months ago
5.10.0
10 months ago
5.8.0
11 months ago
5.9.0
10 months ago
5.7.0
11 months ago
5.5.0
12 months ago
5.6.0
12 months ago
5.4.0
1 year ago
5.3.0
1 year ago
5.2.0
1 year ago
5.1.0
2 years ago
5.0.0
2 years ago
4.6.2
2 years ago
4.7.0
2 years ago
4.6.1
2 years ago
4.5.0
2 years ago
4.4.1
2 years ago
4.6.0
2 years ago
4.4.0
2 years ago
4.3.0
2 years ago
4.2.0
2 years ago
4.1.0
3 years ago
4.0.0
3 years ago
3.0.1
3 years ago
2.5.1
3 years ago
3.0.0
3 years ago
2.5.0
3 years ago
2.4.0
3 years ago
2.3.0
3 years ago
2.2.0
3 years ago
2.1.1
4 years ago
2.1.0
4 years ago
2.0.1
4 years ago
2.0.0
4 years ago
1.21.0
4 years ago
1.20.0
4 years ago
1.19.0
4 years ago
1.18.0
4 years ago
1.17.1
4 years ago
1.17.0
4 years ago
1.16.0
4 years ago
1.15.0
4 years ago
1.14.0
4 years ago
1.13.0
4 years ago
1.12.0
4 years ago
1.10.0
4 years ago
1.9.1
4 years ago
1.9.0
4 years ago
1.8.1
4 years ago
1.8.0
4 years ago
1.7.0
4 years ago
1.6.1
5 years ago
1.6.0
5 years ago
1.5.0
5 years ago
1.4.1
5 years ago
1.4.0
5 years ago
1.3.0
5 years ago