Product Catalog Info
Product Code:
SFT-ADD-PSIM-MDK
Product Description:
Product Description:
ManitouPSIM Developer's Kit
Manitou Developer's Kit contains:
- Web Service SDK
- Code Samples
- Access to Hosted BoldNet
- .Net SDK (Legacy)
- ActiveX SDK (Legacy)
- XML Receiver Driver Development Kit
(development version, not for production system)
- (Beta) MG component development
- All versions of Manitou Database Dictionary (NDA required)
- Reporting Templates
- Documentation
Customer is required to have a minimum of BoldNet Version 1.6
Web Access system to use the Web Services SDK.
Subscription and Annual Support for Manitou Developer's Kit is 12-months from the date of
implementation.
A Manitou Training Gym is recommended with the Manitou Developer's Kit.
https://boldgroup.lightning.force.com/lightning/r/Product2/01t6g000002jG2VAAU/view
Knowledge Base
SWAGGER
SWAGGER is vendor-neutral, language-agnostic interface for describing RESTful APIs.
Our API also includes embedded Swagger documentation. Your developer can access it by navigating to your Manitou URL and appending /api to reach the Swagger landing page. For additional guidance, you may reference the internal KB article: Development - Setting up Swagger and Postman for API testing | Internal KB for API testing. This documentation will give you every available API call within our API that your developer can utilize (it is all in there).
https://sdksupport.boldgroup.solutions/api/swagger/ui/index#/
SWAGGER Documentation (Can be provided to the customer as PDF)
Development - Setting up Swagger and Postman for API testing | Internal KB for API testing.
KB on how the swagger and postman works for the end-user once the API is stood up by a System Consultant:
https://securityandalarminternalkb.knowledgeowl.com/help/-5735
Documentation (Can be provided to the customer as PDF)
This link to an internal KB article that explains the connection via POSTMAN:
https://securityandalarminternalkb.knowledgeowl.com/help/1208
Example json testing file
A sample API calls the customer could use to test how the process works
Manitou API Calls.postman_collection.json
This is a Postman Collection file that includes numerous examples of the various API calls available through the Manitou API. If your developer isn’t familiar with Postman, they can learn more and set up a free account at https://www.postman.com/home. This is the tool our developers commonly use to view and test Manitou API calls.
Manitou API Calls.postman_collection.json
Authentication
For authentication, the integration should use a BoldNet remote user configured specifically for this purpose. Please ensure that the BoldNet user has the appropriate permissions to view, update, delete, and perform any actions required through the API.
MANDD is Manitou Data Dictionary
the MANDD is Manitou Data Dictionary is the dictionary used by developers and/or DBAs to know how the database is structured and answers to what each field means etc.
MANDD is Manitou Data Dictionary
Customer setup information
The username and password referenced in the document are BoldNet users. The URL would be the BoldNet URL, when they setup the users in BoldNet they just have to have the appropriate permissions to perform the actions they will be attempting to do with the API, for example edit/update account information etc.
Email support
Important: Email support is provided for MDK.
1) If a Customer / Developer requires support, they need to raise a standard Bold Support ticket with the subject "MDK Support". The ticket is vetted by L3 and if they can't answer, the SME Sharon Nowland will support.
or
2) API related questions, please contact sdksupport@boldgroup.com
Pre-Requisite Document
n/a
Supplementary information
Developer support is not includedImportant: Developer support is not part of the MDK product. Additional custom development time consulting hours can be purchased as a change order. There are restrictions when a developer is available.
RESTful API
MDK includes RESTful API
RESTful API can provide communication between Manitou and SedonaOffice / Managely
Mandator add on modules for Accounting Integration
Both MDK and Accounting Integration add on modules are required for Manitou and SedonaOffice / Managely to communicate.
End point
BoldNet and the MDK are essentially the same thing. The "api endpoint" is simply using the "/api" instead of "/manitou".
Swagger end point
Under the hood, everything a BoldNet user does in BoldNet is simply making api calls to the "/api" endpoint. We just allow customers to customize these api calls via the MDK package that they purchase + the swagger library of api calls. We will want to make sure that the customer has the swagger library of api calls available to the api. They can access this library using the link below:
https://customerName.manitoucloud.com/api/swagger
Effort and Process
On Prem
If BoldNet is already installed, not much additional effort
>There is no licensing for MDK (or on Media Gateway) and that the API just works through BoldNet.
>The customer is required to setup BoldNet users with proper permissions for the API login (edit/update account information etc.)
Process: If BoldNet is NOT already set up
1) System Consultant first needs to stand up the API (install BoldNet)
Process: If BoldNet is already set up
1) The customer should be sent the supporting docs and API info.
Supporting Docs:
A) Example json testing file (see link above)
B) MANDD is Manitou Data Dictionary (see link above)
C) SWAGGER docs https://securityandalarminternalkb.knowledgeowl.com/help/-5735
2) Provide the customer with the MDK Endpoint (listed in SalesForce -> Server Information)
for example:
>BoldNet URL is https://BoldNetneo.tmscentral.com/manitou (linked from www.tmscentral.com which is listed as BoldNet Neo in Salesforce)
>The MDK endpoint that they make calls to is: https://BoldNetneo.tmscentral.com/api/
>Swagger: https://BoldNetneo.tmscentral.com/api/swagger/
Hosted
If BoldNet is already installed, not much additional effort
Process: If BoldNet is NOT already set up
1) System Consultant first needs to stand up the API (install BoldNet)
Process: If BoldNet is already set up
1) The customer should be sent the supporting docs and API info.
Supporting Docs:
A) Example json testing file (see link above)
B) MANDD is Manitou Data Dictionary (see link above)
C) SWAGGER docs https://securityandalarminternalkb.knowledgeowl.com/help/-5735
2) Provide the customer with the MDK Endpoint (listed in SalesForce -> Server Information)
for example:
>BoldNet URL is https://customerName.manitoucloud.com/manitou
>The MDK endpoint that they make calls to is: https://customerName.manitoucloud.com/api
>Swagger: https://customerName.manitoucloud.com/api/swagger/
Questions for the Customer
Question 1: What is the MDK going to be used for?
Question 2: Are you trying to integrate with SFDC and Manitou
Question 3: Is BoldNet is already set up
Question 4: If Accounting Integration is also included in scope, what is Manitou integrating with?
Training
n/a
