alamto_api

AlamtoApi - JavaScript client for alamto_api Vira Human Resource Software Api This SDK is automatically generated by the OpenAPI Generator project:

• API version: v1
• Package version: v1
• Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install alamto_api --save

Finally, you need to build the module:

npm run build

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

To use the link you just defined in your project, switch to the directory you want to use your alamto_api from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var AlamtoApi = require('alamto_api');

var defaultClient = AlamtoApi.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

var api = new AlamtoApi.AuthAPIsAuthApi()
api.apiAuthAuthGetRolePermissionsGet().then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Documentation for API Endpoints

All URIs are relative to http://localhost

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- AlamtoApi.AuthAPIsAuthApi | apiAuthAuthGetRolePermissionsGet | GET /api/Auth/Auth/GetRolePermissions | AlamtoApi.AuthAPIsAuthApi | apiAuthAuthSetActiveRolePut | PUT /api/Auth/Auth/SetActiveRole | AlamtoApi.AuthAPIsAuthApi | apiAuthasdasdAuthGetPermissionsPost | POST /api/Authasdasd/Auth/GetPermissions | AlamtoApi.HisAPIsHisApi | apiHisHisGetInfoPost | POST /api/His/His/GetInfo | AlamtoApi.HisAPIsPersonApi | apiHisPersonGetPersonGet | GET /api/His/Person/GetPerson | AlamtoApi.HisAPIsPersonApi | apiHisPersonInsertPersonPost | POST /api/His/Person/InsertPerson | AlamtoApi.ModuleOneApi | apiModuleOneTestGenericRepositoryInsertProductNameNatCodePost | POST /api/ModuleOne/TestGenericRepositoryInsertProduct/{name}/{natCode} | AlamtoApi.ReactiveGridApiApi | apiReactiveGridApiGet | GET /api/ReactiveGridApi |

Documentation for Models

• AlamtoApi.CourseFilter
• AlamtoApi.PermissionDto
• AlamtoApi.RoleDto
• AlamtoApi.UserAuthDto
• AlamtoApi.UserAuthDtoServiceResponse

Documentation for Authorization

oauth2

• Type: OAuth
• Flow: accessCode
• Authorization URL: https://localhost:8021/connect/authorize
• Scopes:
  • vira_api_scope: Vira API