the_crm_api v0.0.1
the_crm_api
TheCrmApi - JavaScript client for the_crm_api The schema declaration for the CRM api server This SDK is automatically generated by the Swagger Codegen project:
- API version: 0.0.1
- Package version: 0.0.1
- Build package: io.swagger.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 the_crm_api --save
git
If the library is hosted at a git repository, e.g. https://github.com/YOUR_USERNAME/the_crm_api then install it via:
npm install YOUR_USERNAME/the_crm_api --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.
Getting Started
Please follow the installation instruction and execute the following JS code:
var TheCrmApi = require('the_crm_api');
var api = new TheCrmApi.KlantApi()
var naam = "naam_example"; // {String}
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.klantNaamNaamGet(naam, callback);
Documentation for API Endpoints
All URIs are relative to http://127.0.0.1:8081/api
Class | Method | HTTP request | Description |
---|---|---|---|
TheCrmApi.KlantApi | klantNaamNaamGet | GET /klant/naam/{naam} | |
TheCrmApi.KlantApi | klantOrgcodeCodeGet | GET /klant/orgcode/{code} | |
TheCrmApi.KlantApi | klantOrguuidUuidGet | GET /klant/orguuid/{uuid} | |
TheCrmApi.PoortsApi | poortsGet | GET /poorts | |
TheCrmApi.PoortsApi | poortsOrgcodeOrgcodeGet | GET /poorts/orgcode/{orgcode} | |
TheCrmApi.PoortsApi | poortsOrguuidUuidGet | GET /poorts/orguuid/{uuid} | |
TheCrmApi.PoortsApi | poortsPoortPoortidGet | GET /poort/poort/{poortid} | |
TheCrmApi.PoortsApi | poortsServiceServiceidGet | GET /poorts/service/{serviceid} | |
TheCrmApi.PoortsApi | poortsServicetypeServicetypeGet | GET /poorts/servicetype/{servicetype} | |
TheCrmApi.PoortsApi | poortsTypeTypeGet | GET /poorts/type/{type} |
Documentation for Models
- TheCrmApi.Contactpersonen
- TheCrmApi.Contactpersoonrollen
- TheCrmApi.Eigenaar
- TheCrmApi.Error
- TheCrmApi.Klant
- TheCrmApi.Poort
Documentation for Authorization
All endpoints do not require authorization.
8 years ago