{"id":26103325,"url":"https://github.com/constructor-io/constructorio-node","last_synced_at":"2025-04-12T17:23:42.974Z","repository":{"id":34248350,"uuid":"38131569","full_name":"Constructor-io/constructorio-node","owner":"Constructor-io","description":"A Node.js client helper library for the Constructor.io API","archived":false,"fork":false,"pushed_at":"2025-03-10T22:29:39.000Z","size":3286,"stargazers_count":13,"open_issues_count":2,"forks_count":5,"subscribers_count":23,"default_branch":"master","last_synced_at":"2025-04-12T17:23:16.205Z","etag":null,"topics":["autocomplete","constructorio","constructorio-integrations","http","javascript","nodejs","rest-client","search"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Constructor-io.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2015-06-26T20:15:42.000Z","updated_at":"2025-03-03T19:41:18.000Z","dependencies_parsed_at":"2023-10-14T18:55:55.167Z","dependency_job_id":"4e49918b-a990-4f62-9ddd-730b920d6e9e","html_url":"https://github.com/Constructor-io/constructorio-node","commit_stats":{"total_commits":327,"total_committers":23,"mean_commits":"14.217391304347826","dds":0.7217125382262997,"last_synced_commit":"7018ded25617d369deb1aa5ff2a2ca17d82446d9"},"previous_names":["constructor-io/constructorio-javascript"],"tags_count":128,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Constructor-io%2Fconstructorio-node","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Constructor-io%2Fconstructorio-node/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Constructor-io%2Fconstructorio-node/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Constructor-io%2Fconstructorio-node/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Constructor-io","download_url":"https://codeload.github.com/Constructor-io/constructorio-node/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248602867,"owners_count":21131703,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["autocomplete","constructorio","constructorio-integrations","http","javascript","nodejs","rest-client","search"],"created_at":"2025-03-09T20:06:22.308Z","updated_at":"2025-04-12T17:23:42.946Z","avatar_url":"https://github.com/Constructor-io.png","language":"JavaScript","readme":"# Constructor.io Node Client\n\n[![npm](https://img.shields.io/npm/v/@constructor-io/constructorio-node)](https://www.npmjs.com/package/@constructor-io/constructorio-node)\n[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/Constructor-io/constructorio-node/blob/master/LICENSE)\n\nA Node.js client for [Constructor.io](http://constructor.io/). [Constructor.io](http://constructor.io/) provides search as a service that optimizes results using artificial intelligence (including natural language processing, re-ranking to optimize for conversions, and user personalization).\n\n\u003e This client is intended for use in server side integrations.  If you want a JavaScript client for client side (i.e. front end) integrations please use [@constructor-io/constructorio-client-javascript](https://github.com/Constructor-io/constructorio-client-javascript)\n\n## Documentation\nFull API documentation is available on [Github Pages](https://constructor-io.github.io/constructorio-node)\n\nUpdating from v3 to v4? Be sure to read the [upgrade guide](https://github.com/Constructor-io/constructorio-node/wiki/Migration-Guide---V3-to-V4) for an explanation of changes made to the Catalog module\n\n## 1. Review the Requirements\n\nRequesting results from your Node.js back-end can be useful in order to control result rendering logic on your server, or augment/hydrate results with data from another system. However, a back-end integration has additional requirements compared to a front-end integration. Please review the [Additional Information For Backend Integrations](https://github.com/Constructor-io/constructorio-node/wiki/Additional-Information-For-Backend-Integrations) article within the wiki for more detail.\n\n## 2. Install\n\nThis package can be installed via npm: `npm i @constructor-io/constructorio-node`. Once installed, simply import or require the package into your repository.\n\n**Important**: this library should only be used in a server-side context.\n\n## 3. Retrieve an API key and token\n\nYou can find this in your [Constructor.io dashboard](https://constructor.io/dashboard). Contact sales if you'd like to sign up, or support if you believe your company already has an account.\n\n## 4. Implement the Client\n\nOnce imported, an instance of the client can be created as follows:\n\n```javascript\nconst ConstructorIOClient = require('@constructor-io/constructorio-node');\n\nvar constructorio = new ConstructorIOClient({\n    apiKey: 'YOUR API KEY',\n});\n```\n\n## 5. Retrieve Results\n\nAfter instantiating an instance of the client, four modules will be exposed as properties to help retrieve data from Constructor.io: `search`, `browse`, `autocomplete`, `recommendations`, `catalog` and `tracker`.\n\n## Development / npm commands\n\n```bash\nnpm run lint          # run lint on source code and tests\nnpm run test          # run tests\nnpm run coverage      # run tests and serves coverage reports from localhost:8081\nnpm run docs          # output documentation to `./docs` directory\n```\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fconstructor-io%2Fconstructorio-node","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fconstructor-io%2Fconstructorio-node","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fconstructor-io%2Fconstructorio-node/lists"}