{"_id":"@axway-api-builder-ext/syncplicity-connector","_rev":"4-51c814c0b137fb705ada6f19a9f659a6","name":"@axway-api-builder-ext/syncplicity-connector","dist-tags":{"latest":"1.0.0"},"versions":{"1.0.0":{"name":"@axway-api-builder-ext/syncplicity-connector","version":"1.0.0","description":"Use this connector to integrate with Axway Syncplicity","main":"index.js","scripts":{"postinstall":"node scripts/postinstall.js","uninstall":"node scripts/uninstall.js"},"repository":{"type":"git","url":"git+https://github.com/Axway-API-Builder-Ext/api-builder-extras.git"},"keywords":["amplify","api-builder","flow","axway","syncplicity"],"author":{"name":"Chris Wiechmann","email":"cwiechmann@axway.com","url":"http://www.axway.com"},"license":"Apache-2.0","bugs":{"url":"https://github.com/Axway-API-Builder-Ext/api-builder-extras/issues"},"homepage":"https://github.com/Axway-API-Builder-Ext/api-builder-extras/tree/master/api-builder-plugin-fc-syncplicity","dependencies":{},"_id":"@axway-api-builder-ext/syncplicity-connector@1.0.0","_nodeVersion":"12.14.1","_npmVersion":"6.13.4","dist":{"integrity":"sha512-Gc2hzgtaAQfihPU6WkvFL6a4UjWbP7sM9oEYC71o+iwLMXzOL6Uz0484hAram6WbhYv8jfuO/T8rZPJ7UUf6xw==","shasum":"7aeb21789ae51af6bcd37ced60f4daa9c4d06981","tarball":"https://registry.npmjs.org/@axway-api-builder-ext/syncplicity-connector/-/syncplicity-connector-1.0.0.tgz","fileCount":7,"unpackedSize":374243,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeOA5NCRA9TVsSAnZWagAAo60QAJi7zTjnaQozRo4aH98X\nv9bfqWyx8FJsatltve05qRMNL48PNu9F7Une2gBSzX3BfLRa4ZPw5qG14Po5\nJ3vu2kAxAxvf+h4OlSy13vg29fdkHehI2g3lqAIsvcHi43xV6mBhWLhqP1Vn\n+HACdsUzUTP0II+vlareBhRYwLducTwKsBknCqdhw4zV5vLmYBciks0La15j\nby9ph6p8bPLuEjKUMhnaiuAeYcwXac0fCSvg48PCDjSTLzCSZ7sXQMNLynhV\ni78BBtP8Iv00Mlp2fNDTAa9oPQdQvm/ZfmRpswOzvToZKmNUYjFtogHshlD/\nyb/FoCCPVPiJdR6+qiKtaHcFVw3pfNfLyCfGiu6NgkRB9j+fZjvgqGlbm5Ue\n0cfblmR6bnygZPULewrN4OL50vNTMmRzExk5uEBQFvPPMn70OW90AscqJuBa\n2LOPq7QcV5LlBO5qBxwbvxo8Iyfk436kmRbsSdM2DoyqqrJ40n3WSdWuyqRl\nVZ874z8abpt+7p5SUadc6nY3hS9DuKymm2wk/fQeIogCh6iUECbWhwqJr9Pi\nx+73l782XsiTMcDNceDUqmq1f/NBnar6B1FkGvGJKSFZBP5+n+C/9fBo+gBG\ntTE8BGAudyYOatSOAEEEfXyN7PlnitF0NfUpQHD3VE6LcdQKNKm1pIqTWTFs\nZGAW\r\n=BpBM\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCDsmywtQN2lsUlYh9qvIMGKXJ21dKHYHo1ZVouJX5BRAIhAPoDkp3WTPIo3UqCISM6fbtGRS2Exf+EUJp7LWkqjs1v"}]},"maintainers":[{"name":"cwiechmann","email":"cwiechmann@axway.com"}],"_npmUser":{"name":"cwiechmann","email":"cwiechmann@axway.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/syncplicity-connector_1.0.0_1580731980774_0.021186894666438416"},"_hasShrinkwrap":false}},"time":{"created":"2020-02-03T12:13:00.544Z","1.0.0":"2020-02-03T12:13:00.930Z","modified":"2023-10-10T16:24:59.859Z"},"maintainers":[{"email":"ahurst@axway.com","name":"axway_alasdair"}],"description":"Use this connector to integrate with Axway Syncplicity","homepage":"https://github.com/Axway-API-Builder-Ext/api-builder-extras/tree/master/api-builder-plugin-fc-syncplicity","keywords":["amplify","api-builder","flow","axway","syncplicity"],"repository":{"type":"git","url":"git+https://github.com/Axway-API-Builder-Ext/api-builder-extras.git"},"author":{"name":"Chris Wiechmann","email":"cwiechmann@axway.com","url":"http://www.axway.com"},"bugs":{"url":"https://github.com/Axway-API-Builder-Ext/api-builder-extras/issues"},"license":"Apache-2.0","readme":"# API-Builder Syncplicity Connector\n\nUse this connector to communicate with the [Syncplicity by Axway](https://www.syncplicity.com/en) and make it part of your API-Management platform.  \n\n## Installation\nTo install it into you API-Builder project execute:\n```npm\nnpm install @axway-api-builder-ext/syncplicity-connector --no-optional\n```\nTo install a specific version please use:\n```npm\nnpm install @axway-api-builder-ext/syncplicity@1.0.0 --no-optional\n```\n\nThis connector is using the Swagger-Flow node:  \nhttps://docs.axway.com/bundle/API_Builder_4x_allOS_en/page/swagger_flow-node.html  \n\n\n## Configuration\nAfter restarting your API-Builder project you get the following connector:  \n![Syncplicity Node][connector]   \nDepending on the selected method different options appear on the right, when using the connector as part of the flow.   \n![Syncplicity Node Settings][connector-settings]   \n\n## Setup Syncplicity connector\nA new config file has been automatically created for the Syncplicity Connector which can be used to setup the connection details:  \n![Syncplicity Node Settings][connector-config]  \nAdditional details can be found here: https://docs.axway.com/bundle/API_Builder_4x_allOS_en/page/swagger_flow-node.html#Swaggerflow-node-ConfiguretheSwaggerplugin  \n\n\nPlease note, that the connector is configured to use OAuth 2.0 to communicate with Syncplicuty. In order to use that, please configure the Authentication-Credentials as described here:  \nhttps://docs.axway.com/bundle/API_Builder_4x_allOS_en/page/oauth_2_0_credentials.html  \n\n\n```javascript\nmodule.exports = {\n\t// The configuration settings for your Swagger service.\n\tpluginConfig: {\n\t\t'@axway/api-builder-plugin-fn-swagger': {\n\t\t\t'syncplicity': {\n\t\t\t\t// It is possible to override Swagger URI options when constructing\n\t\t\t\t// outbound requests from the Swagger plugin.\n\t\t\t\turi: {\n\t\t\t\t\t// protocol: 'https',\n\t\t\t\t\t// host: 'hostname',\n\t\t\t\t\t// port: 443,\n\t\t\t\t\t// basePath: '/api'\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t},\n\t// The following authorization credentials needed to use the Swagger service.\n\t// Please follow this guide to manually configure the credentials:\n\t// https://docs.axway.com/bundle/API_Builder_4x_allOS_en/page/api_builder_credentials.html\n\tauthorization: {\n\t\tcredentials: {\n\t\t\t'Syncplicity oauth': {\n\t\t\t\ttype: 'oauth2',\n\t\t\t\tflow: 'accessCode',\n\t\t\t\tauthentication_url: 'https://api.syncplicity.com/oauth/authorize',\n\t\t\t\ttoken_url: 'https://api.syncplicity.com/oauth/token',\n\t\t\t\tscope: 'readwrite read',\n\t\t\t\tclient_id: 'YOUR_CLIENT_ID_GOES_HERE',\n\t\t\t\tclient_secret: 'YOUR_SECRET_GOES_HERE',\n\t\t\t\taccess_token: null,\n\t\t\t\trefresh_token: null\n\t\t\t}\n\t\t}\n\t}\n};\n```\n\n## Compatibility\nTested with Syncplicity version Q1/2020\n\n## Changelog\n- 1.0.0 - 02.02.2020\n  - Initial version\n\n## Limitations/Caveats\n- OAuth doesn't work with API-Builder - Will be fixed with release 16.02.20\n  Adjust the following to make it work  \n\tIn node_modules\\@axway\\axway-flow-authorization\\src\\handlers\\oauth2.js  \n\tIn function oauthRequest add an HTTP-Basic Authorization header (headers) based on client-id & secret  \n\tExample:  \n\t'Authorization': 'Basic YWQ0ODA1YWUtZ........Y2JlOGQ0OTI5YQ=='\n\n## Contributing\n\nPlease read [Contributing.md](https://github.com/Axway-API-Management-Plus/Common/blob/master/Contributing.md) for details on our code of conduct, and the process for submitting pull requests to us.  \n\n\n## Team\n\n![alt text][Axwaylogo] Axway Team\n\n[Axwaylogo]: https://github.com/Axway-API-Management/Common/blob/master/img/AxwayLogoSmall.png  \"Axway logo\"\n\n\n## License\n[Apache License 2.0](/LICENSE)\n\n[connector]: misc/images/Syncplicity-Connector.png\n[connector-settings]: misc/images/Syncplicity-Connector-Settings.png\n[connector-config]: misc/images/Syncplicity-Connector-Config.png\n","readmeFilename":"README.md"}