{"id":18051756,"url":"https://github.com/apimatic/apimatic-sdk-for-js","last_synced_at":"2025-04-05T07:13:46.456Z","repository":{"id":68154751,"uuid":"416289134","full_name":"apimatic/apimatic-sdk-for-js","owner":"apimatic","description":"APIMatic SDK for it's public APIs for js","archived":false,"fork":false,"pushed_at":"2023-09-28T11:55:08.000Z","size":827,"stargazers_count":0,"open_issues_count":2,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-02-10T14:53:18.551Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/apimatic.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":"2021-10-12T10:26:39.000Z","updated_at":"2021-12-01T10:06:30.000Z","dependencies_parsed_at":null,"dependency_job_id":"2b534847-56fa-47e5-a60a-0c4ea6ea0438","html_url":"https://github.com/apimatic/apimatic-sdk-for-js","commit_stats":null,"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apimatic%2Fapimatic-sdk-for-js","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apimatic%2Fapimatic-sdk-for-js/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apimatic%2Fapimatic-sdk-for-js/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apimatic%2Fapimatic-sdk-for-js/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/apimatic","download_url":"https://codeload.github.com/apimatic/apimatic-sdk-for-js/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247299850,"owners_count":20916193,"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":[],"created_at":"2024-10-30T22:55:40.966Z","updated_at":"2025-04-05T07:13:46.435Z","avatar_url":"https://github.com/apimatic.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n# Getting Started with Apimatic API\n\n## Introduction\n\nThis API gives you programmatic access to APIMatic's Code Generation, Docs Generation and Transformers Engine.\n\n## Building\n\n### Requirements\n\nThe SDK relies on **Node.js** and **npm** (to resolve dependencies). You can download and install Node.js and [npm](https://www.npmjs.com/) from [the official Node.js website](https://nodejs.org/en/download/).\n\n\u003e **NOTE:** npm is installed by default when Node.js is installed.\n\n### Verify Successful Installation\n\nRun the following commands in the command prompt or shell of your choice to check if Node.js and npm are successfully installed:\n\n* Node.js: `node --version`\n\n* npm: `npm --version`\n\n![Version Check](https://apidocs.io/illustration/typescript?workspaceFolder=ApimaticAPI\u0026step=versionCheck)\n\n### Install Dependencies\n\n- To resolve all dependencies, go to the **SDK root directory** and run the following command with npm:\n\n```bash\nnpm install\n```\n\n- This will install all dependencies in the **node_modules** folder.\n\n![Resolve Dependencies](https://apidocs.io/illustration/typescript?workspaceFolder=ApimaticAPI\u0026workspaceName=apimatic-apilib\u0026step=resolveDependency)\n\n## Installation\n\nThe following section explains how to use the generated library in a new project.\n\n### 1. Initialize the Node Project\n\n- Open an IDE/text editor for JavaScript like Visual Studio Code. The basic workflow presented here is also applicable if you prefer using a different editor or IDE.\n\n- Click on **File** and select **Open Folder**. Select an empty folder of your project, the folder will become visible in the sidebar on the left.\n\n![Open Folder](https://apidocs.io/illustration/typescript?step=openProject)\n\n- To initialize the Node project, click on **Terminal** and select **New Terminal**. Execute the following command in the terminal:\n\n```bash\nnpm init --y\n```\n\n![Initialize the Node Project](https://apidocs.io/illustration/typescript?step=initializeProject)\n\n### 2. Add Dependencies to the Client Library\n\n- The created project manages its dependencies using its `package.json` file. In order to add a dependency on the *Apimatic APILib* client library, double click on the `package.json` file in the bar on the left and add the dependency to the package in it.\n\n![Add ApimaticApilib Dependency](https://apidocs.io/illustration/typescript?workspaceFolder=ApimaticAPI\u0026workspaceName=apimatic-apilib\u0026step=importDependency)\n\n- To install the package in the project, run the following command in the terminal:\n\n```bash\nnpm install\n```\n\n![Install ApimaticApilib Dependency](https://apidocs.io/illustration/typescript?step=installDependency)\n\n## Initialize the API Client\n\n**_Note:_** Documentation for the client can be found [here.](/doc/client.md)\n\nThe following parameters are configurable for the API Client:\n\n| Parameter | Type | Description |\n|  --- | --- | --- |\n| `timeout` | `number` | Timeout for API calls.\u003cbr\u003e*Default*: `0` |\n| `authorization` | `string` | Auth Header. Replace {x-auth-key} with your API Key. |\n\nThe API client can be initialized as follows:\n\n```ts\nconst client = new Client({\n  timeout: 0,\n  authorization: 'Authorization',\n})\n```\n\n## Authorization\n\nThis API uses `Custom Header Signature`.\n\n## List of APIs\n\n* [APIs Management](/doc/controllers/apis-management.md)\n* [Code Generation - Imported APIs](/doc/controllers/code-generation-imported-apis.md)\n* [Code Generation - External APIs](/doc/controllers/code-generation-external-apis.md)\n* [Transformation](/doc/controllers/transformation.md)\n* [Docs Portal Management](/doc/controllers/docs-portal-management.md)\n* [API Validation - Imported APIs](/doc/controllers/api-validation-imported-apis.md)\n* [API Validation - External APIs](/doc/controllers/api-validation-external-apis.md)\n* [Package Deployment](/doc/controllers/package-deployment.md)\n\n## Classes Documentation\n\n* [ApiResponse](/doc/api-response.md)\n* [ApiError](/doc/api-error.md)\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapimatic%2Fapimatic-sdk-for-js","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fapimatic%2Fapimatic-sdk-for-js","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapimatic%2Fapimatic-sdk-for-js/lists"}