# @plasma-platform/service-api > Common tm microservice api methods Latest version **2.6.0** (published 2020-03-03) · ISC license · 0 weekly downloads ## Install ```sh npm install @plasma-platform/service-api pnpm add @plasma-platform/service-api yarn add @plasma-platform/service-api bun add @plasma-platform/service-api ``` ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 2.6.0 | | Published | 2020-03-03 | | First published | 2019-03-15 | | Weekly downloads | 0 | | License | ISC | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 1 | | Unpacked size | 47.2 KB | | Known vulnerabilities | 0 | | Install scripts | no | | Author | Sergey Mirza | | Maintainers | alexandrmardanov, ch-tm, kyrylovoronoi, lven, mice-tm, stevenreed, tmrdowner, viram | | Keywords | TM Micro Service, Template Monster, API | ## Links - npm: https://www.npmjs.com/package/@plasma-platform/service-api - Repository: git@gitlab.com:TemplateMonster/PlasmaPlatform/Frontend/plasma-platform - Homepage: https://gitlab.com/TemplateMonster/PlasmaPlatform/Frontend/plasma-platform/tree/master/packages/service-api - npm.io page: https://npm.io/package/@plasma-platform/service-api ## Dependencies (1) - [can-param](https://npm.io/package/can-param.md) ^1.1.1 ## Recent versions - 2.6.0 (latest) — 2020-03-03 - 2.5.18 — 2020-01-23 - 2.5.17 — 2019-11-28 - 2.5.15 — 2019-11-13 - 2.5.15-alpha.0 — 2019-11-08 - 2.5.14 — 2019-08-23 - 2.5.17-alpha.0 — 2019-08-22 - 2.5.16-alpha.0 — 2019-08-22 - 2.5.14-alpha.0 — 2019-08-22 - 2.5.13 — 2019-08-08 - 2.5.13-alpha.0 — 2019-08-08 - 2.5.12-alpha.0 — 2019-08-08 - 2.5.11 — 2019-08-07 - 2.5.9 — 2019-07-26 - 2.5.8 — 2019-07-15 - … 34 more at https://npm.io/package/@plasma-platform/service-api/versions ## README ![version](https://badgen.net/npm/v/@plasma-platform/service-api) ![nextVersion](https://badgen.net/npm/v/@plasma-platform/service-api/next) ![downloads](https://badgen.net/npm/dt/@plasma-platform/service-api) ![license](https://badgen.net/npm/license/@plasma-platform/service-api) ![dependency](https://badgen.net/npm/dependents/@plasma-platform/service-api) * * * [Full documentation](https://templatemonster.gitlab.io/PlasmaPlatform/Frontend/plasma-platform/?path=/story/plasma-platform-sdk--service-api) install: `npm i @plasma-platform/service-api -S` # Short documentation ### Table of Contents - [TMMicroServiceAPI](#tmmicroserviceapi) - [Parameters](#parameters) - [url](#url) - [Properties](#properties) - [token](#token) - [Properties](#properties-1) - [timeOut](#timeout) - [Properties](#properties-2) - [timeOutObjects](#timeoutobjects) - [Properties](#properties-3) - [messages](#messages) - [setUrl](#seturl) - [Parameters](#parameters-1) - [setToken](#settoken) - [Parameters](#parameters-2) - [setTimeOut](#settimeout) - [Parameters](#parameters-3) - [setVersion](#setversion) - [Parameters](#parameters-4) - [checkVersion](#checkversion) - [Parameters](#parameters-5) - [request](#request) - [Parameters](#parameters-6) - [tmpVersion](#tmpversion) - [Properties](#properties-4) - [ErrorNotFound](#errornotfound) - [Parameters](#parameters-7) - [ErrorServerResponse](#errorserverresponse) - [Parameters](#parameters-8) - [ErrorBadRequest](#errorbadrequest) - [Parameters](#parameters-9) ## TMMicroServiceAPI TM Micro Service Proto API ### Parameters - `url` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** service url - `token` **([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | null)** user access token if available (optional, default `null`) ## url Service URL ### Properties - `service` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** url ## token User access token ### Properties - `token` **([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | null)?** user access token if available ## timeOut timeOut for request ### Properties - `timeOut` **([number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number) \| [boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean))?** time for timeout request ## timeOutObjects timeOutObjects container for timeouts ### Properties - `timeOut` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?** container for timeouts ## messages Object with class service messages Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object) ## setUrl Set url ### Parameters - `url` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** ## setToken Set access token ### Parameters - `token` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** access token ## setTimeOut Set timeOut ### Parameters - `milliseconds` **integer** milliseconds time ## setVersion Set service version ### Parameters - `version` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** service version ## checkVersion Validate service version ### Parameters - `version` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** service version - Throws **[Error](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error)** if URL do not match format Error will be thrown Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** version - service version ## request Fetch remote resource ### Parameters - `url` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** resource url - `userOptions` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** user defined options Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)** Promise with server [Response](https://developer.mozilla.org/docs/Web/API/Response) ## tmpVersion Service version ### Properties - `version` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** service version ## ErrorNotFound Custom error message for Not Found server response ### Parameters - `message` **([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | null)** error details (optional, default `null`) ## ErrorServerResponse Custom error message for abstract server response ### Parameters - `statusCode` **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** http status code - `statusText` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** http status code text - `message` **([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | null)** error details (optional, default `null`) ## ErrorBadRequest Custom error message for Bad Request server response ### Parameters - `message` **([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | null)** error details (optional, default `null`) --- _Source: https://npm.io/package/@plasma-platform/service-api · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._