{"_id":"@aurigma/axios-rendering-service-api-client.ts","_rev":"8-9f7f6951889af46a4c1876efe236b0a9","name":"@aurigma/axios-rendering-service-api-client.ts","dist-tags":{"latest":"2.16.1"},"versions":{"2.15.2":{"name":"@aurigma/axios-rendering-service-api-client.ts","version":"2.15.2","keywords":["customer's canvas","web-to-print","api client","rendering service"],"author":{"url":"https://customerscanvas.com","name":"Aurigma Inc","email":"info@aurigma.com"},"license":"SEE LICENSE IN License.md","_id":"@aurigma/axios-rendering-service-api-client.ts@2.15.2","maintainers":[{"name":"asimontsev","email":"a.simontsev@aurigma.com"},{"name":"maxsmaleha","email":"maxsmaleha@gmail.com"},{"name":"stas.gusarov","email":"stas.gusarov@gmail.com"},{"name":"mcsimusic","email":"mcsimusic@gmail.com"},{"name":"t.vybornova","email":"tanya@aurigma.com"}],"homepage":"https://customerscanvas.com","bugs":{"url":"https://customerscanvas.com/account/cases"},"dist":{"shasum":"ac11d3ad3ddf11bcc73e88a1d12d47cd822c4317","tarball":"https://registry.npmjs.org/@aurigma/axios-rendering-service-api-client.ts/-/axios-rendering-service-api-client.ts-2.15.2.tgz","fileCount":9,"integrity":"sha512-fVn83etG7Be8ohyo8UeFMx72f6slxHDcrcCI7Svo5/fksggRYwRwMT2JXOpQeTPc8MJwbBEfKtu7Q+sMt+bwHg==","signatures":[{"sig":"MEUCIQDu4wf5UIz5nfD7xowrufGDosmM3Xm5k2z+brjO6BG6oAIgKGs9/H2h3SydRk+/eNkprXViv4Kg1zPAhJKuJU5YyCs=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":152925,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJh4Q00CRA9TVsSAnZWagAAQmwP/0vNon7M2gNj0hMO9e/M\nQhHh500tnyc1vqusO734K2rdXcTNu8rxJ9kufN1YiR9HHZQ/MXgopb/+Kdfx\n7RTReHpYsDhITucS1ZbTiUN5Sca1ccVeS8Rkb8WUhMGe7kM0DqvUKfVf6vWD\nZHMX34puap98cUVXizxL5TwHqyn4suS4TJ8/Yw7ZEPduJMur2iylA2NxvPgY\n/si1itW3MQGymfCuP6IetjFKKL22B9X+dRC3uTvvzXXSF+ircI3f4s+nR8iI\n+k6txEjCNk32eFA4BMsQf/wIQ6doj6bE+9RoRr5Itt9aPoXbNuEfY2cMH/wL\nFz8I4Ag9dKqtLBRcWo2QnWVclVLrZECbe57mcbj9lUOrTZSCz9+gDm6ZX6RP\nVDg6pjK76+oAvXkti1yovhqbAM7+oeSqu5n71D1WrpBhhMgYJLNwmNH7f8tC\niaFZohwSNV+tKq0odbrjaSWz93xuljt4fiA3AMoVDlvpsPN0sf4jK1MQ7411\ngen/J4TniDIDwbk9T42Y2h4x9UPuECrAnJeI2qIWL9hoYWjh2XLX994XZkdR\npT0yZ+tWnpe+kHM0vY36Pliq+NknBXr3SbERNWannmV4xEO8cHcHbey6xlm9\na5ISDY/RsJGFRuiat3yeHf2LkcgM6HI14YcZomKfKbrYIwqioGrkH6O1ISt6\nifbI\r\n=Nvub\r\n-----END PGP SIGNATURE-----\r\n"},"main":"./dist/cjs/rendering-service-api-client.js","types":"./dist/esm/rendering-service-api-client.d.ts","module":"./dist/esm/rendering-service-api-client.js","exports":{"import":"./dist/esm/rendering-service-api-client.js","require":"./dist/cjs/rendering-service-api-client.js"},"scripts":{},"_npmUser":{"name":"maxsmaleha","email":"maxsmaleha@gmail.com"},"_npmVersion":"6.14.7","description":"Axios API Client for Rendering Service API service of Customer's Canvas web-to-print system.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","dependencies":{"npm":"^6.13.6","axios":"^0.24.0"},"_hasShrinkwrap":false,"devDependencies":{"fs-extra":"^10.0.0","typescript":"^4.5.2","@types/node":"^16.11.10"},"_npmOperationalInternal":{"tmp":"tmp/axios-rendering-service-api-client.ts_2.15.2_1642138932142_0.7349643708688991","host":"s3://npm-registry-packages"}},"2.16.1":{"name":"@aurigma/axios-rendering-service-api-client.ts","version":"2.16.1","keywords":["customer's canvas","web-to-print","api client","rendering service"],"author":{"url":"https://customerscanvas.com","name":"Aurigma Inc","email":"info@aurigma.com"},"license":"SEE LICENSE IN License.md","_id":"@aurigma/axios-rendering-service-api-client.ts@2.16.1","maintainers":[{"name":"asimontsev","email":"a.simontsev@aurigma.com"},{"name":"maxsmaleha","email":"maxsmaleha@gmail.com"},{"name":"stas.gusarov","email":"stas.gusarov@gmail.com"},{"name":"mcsimusic","email":"mcsimusic@gmail.com"},{"name":"t.vybornova","email":"tanya@aurigma.com"}],"homepage":"https://customerscanvas.com","bugs":{"url":"https://customerscanvas.com/account/cases"},"dist":{"shasum":"accf9c5c3f0a63ecdfe55a76dd5c03298fe49a53","tarball":"https://registry.npmjs.org/@aurigma/axios-rendering-service-api-client.ts/-/axios-rendering-service-api-client.ts-2.16.1.tgz","fileCount":9,"integrity":"sha512-z2lLH2c0+CcWX/c4LEMhY9kbo23ZfBTYAO8MD0kf3+xPuvfJexmmzyK/OMb1WQHjBs0jVjyxDyGOTRTwAd5wlA==","signatures":[{"sig":"MEYCIQCLOfNxL3kQFvwH+Nh05/UJorNuNxPVAuE408T9y892AwIhAJKKHQDNsAOXuf7RyK9tSUHTVI0OLSi7EH6b6W9M3D5n","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":142758,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJh6oudCRA9TVsSAnZWagAAKjoP/1Iym0l7sWKAdZUrD1mx\nMafU1jrRoGM2X5w/CGPCZ9l2k4mwnyXgYKpxIysaUGWdK0r+eCcw9Z7J0bHX\nSZuUDsHsrBmbCChmp/pcgWQlo7kIM4gpCQ9PfDrVZucyBYknwah7vKwjjpsp\nq168JSnoqWoPRiTQXpsdxPHcWkweqrgs85l4D02YcX/FQTuyYDlW+HlZFJN0\nQt6UYYJ+xdGTXRQwBxa6+dbHS6GqIWPq+sYknluTMBiq32VA3BRMhWKv6dCz\n/llHXjTF99XbQ+jYjeHeN7qx14kBMa4pwI6iii51z+5TuWKficRgwRfD1WC0\nUuFE2WR+8BNiCXNRys2q9a2gyFmux3TWRxfbWaJ/X6QhxO/ry8HAbRkE+dz+\nVeK8JSeN3Kl8MbMOTWzbArYUYR08S5Mi0X2yRokxhefr4/eG7Pndy9811b+w\nwBcnrXNeXtJFKS4ML2zgYQ6rZCeuDwTWEUZEQXJmpMxoZf2VbFm/CuIOxXJg\nYa9Cw2otQAfpaNj5zDQfPBN/ZLGaK/egrHG5cYRcs30r9H895JBXVflklO+S\nt9ByfPBqlt656Vth52AVNZiK74JAj5tREJ/d9egzxuoebAUjbTdU182vPzCV\n+7NPUuMamKjygbJ8Owka3SecR0cnBnFWvST+AvS6FbDJSVzBUPrO1aN/x4SA\nEXFF\r\n=5RcJ\r\n-----END PGP SIGNATURE-----\r\n"},"main":"./dist/cjs/rendering-service-api-client.js","types":"./dist/esm/rendering-service-api-client.d.ts","module":"./dist/esm/rendering-service-api-client.js","exports":{"import":"./dist/esm/rendering-service-api-client.js","require":"./dist/cjs/rendering-service-api-client.js"},"scripts":{},"_npmUser":{"name":"maxsmaleha","email":"maxsmaleha@gmail.com"},"_npmVersion":"6.14.7","description":"Axios API Client for Rendering Service API service of Customer's Canvas web-to-print system.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","dependencies":{"npm":"^6.13.6","axios":"^0.24.0"},"_hasShrinkwrap":false,"devDependencies":{"fs-extra":"^10.0.0","typescript":"^4.5.2","@types/node":"^16.11.10"},"_npmOperationalInternal":{"tmp":"tmp/axios-rendering-service-api-client.ts_2.16.1_1642761116915_0.2957811768573877","host":"s3://npm-registry-packages"}}},"time":{"created":"2022-01-14T05:42:12.085Z","modified":"2026-01-22T08:00:17.065Z","2.15.2":"2022-01-14T05:42:12.344Z","2.16.1":"2022-01-21T10:31:57.124Z"},"bugs":{"url":"https://customerscanvas.com/account/cases"},"author":{"url":"https://customerscanvas.com","name":"Aurigma Inc","email":"info@aurigma.com"},"license":"SEE LICENSE IN License.md","homepage":"https://customerscanvas.com","keywords":["customer's canvas","web-to-print","api client","rendering service"],"description":"Axios API Client for Rendering Service API service of Customer's Canvas web-to-print system.","maintainers":[{"email":"a.simontsev@aurigma.com","name":"asimontsev"},{"email":"tanya@aurigma.com","name":"t.vybornova"},{"email":"v.kozlov@aurigma.com","name":"vitaliykozlov"}],"readme":"# Aurigma Customer's Canvas SDK - Rendering Service API Client\n\nThis module is an Axios API client for Rendering Service API service which is a part of [**Customer's Canvas**](https://customerscanvas.com) web-to-print system. It is supposed that you are familiar with its services and understand how to use its APIs. To learn more about Customer's Canvas and its services, refer the [Getting Started section of its documentation](https://customerscanvas.com/dev/getting-started/intro.html).\n\nThe API client is automatically generated with [NSwag tool](https://github.com/RicoSuter/NSwag). If for any reasons this API client does not work well for you, feel free to generate it yourself using Swagger document published at [Customer's Canvas API Gateway](https://api.customerscanvashub.com/).\n\n## Pre-requisites\n\nTo be able to use this package, you need to meet the following requirements:\n\n- You must have an account at Customer's Canvas.\n- You need to use it in Javascript\\Typescript applications.\n\nFor other platforms, see the [Backend services](https://customerscanvas.com/dev/getting-started/about-backend-services.html) article in Customer's Canvas documentation.\n\n## Usage\n\nInstall it as a regular npm package:\n\n```\nnpm install @aurigma/axios-rendering-service-api-client\n```\n\n### NodeJs\n\nReceive an access token through your backend as explained in the [documentation](https://customerscanvas.com/dev/getting-started/about-backend-services.html#authorization) and deliver it to your app.\n\n```js\nconst renderingServiceApiClient = require(\"@aurigma/axios-rendering-service-api-client\").RenderingServiceApiClient;\nconst axios = require(\"axios\").default;\n\n// You need to create external app in BackOffice with required scopes to receive clientId\\clientSecret\n// https://customerscanvas.com/dev/getting-started/about-backend-services.html#authorization\nconst clientId = \"\";\nconst clientSecret = \"\";\nconst apiUrl = \"https://api.customerscanvashub.com/\";\n\nconst getToken = async (clientId, clientSecret) => {\n  const requestConfig = {\n    method: \"post\",\n    url: apiUrl + \"connect/token\",\n    headers: {\n      \"Content-Type\": \"application/x-www-form-urlencoded\",\n    },\n    data: new URLSearchParams({\n      client_id: clientId,\n      client_secret: clientSecret,\n      grant_type: \"client_credentials\",\n    }),\n  };\n\n  const response = await axios(requestConfig);\n  return response.data[\"access_token\"];\n};\n\nconst token = await getToken(clientId, clientSecret);\n```\n\nAnd then you can call ApiClients methods with this token:\n\n```js\nconst config = new renderingServiceApiClient.ApiClientConfiguration();\nconfig.apiUrl = apiUrl;\nconfig.setAuthorizationToken(token);\n\nconst buildInfoClient = new renderingServiceApiClient.BuildInfoApiClient(config);\nconst buildInfo = await buildInfoClient.getInfo();\n\nconsole.log(token);\nconsole.log(buildInfo);\n```\n\n### Frontend\n\nYou should retrieve access token from your backend, how it's explained above.\n\n```ts\nimport { RenderingServiceApiClient } from \"@aurigma/axios-rendering-service-api-client\";\n\n// get token on backend by clientId\\clientSecret. Never use clientId\\clientSecret on frontend!\n// https://customerscanvas.com/dev/getting-started/about-backend-services.html#authorization\nconst token = \"\";\n\nconst config = new RenderingServiceApiClient.ApiClientConfiguration();\nconfig.apiUrl = \"\";\nconfig.setAuthorizationToken(token);\n\nconst buildInfoClient = new RenderingServiceApiClient.BuildInfoApiClient(config)\nbuildInfoClient.getInfo().then(data => console.log(data));\n```\n\n> NOTE: The class name for each client is formed as <i>ClientName</i>ApiClient, e.g. `BuildInfo` -> `BuildInfoApiClient`, etc.\n","readmeFilename":"README.md"}