Home > Integrations Support > Administrator Guide > Cloud API Technical Aspects

Cloud API Technical Aspects

Table of contents

 

Details

 

Our Cloud API has been created to bridge the data from the on-premises D-Tools server to a cloud API Server, where it becomes available to a subscription from the incoming 3rd party application.

 

It is important to understand how our API has been designed in relationship to our product: As an on-premises application, SI 2018 has no directly accessible API. Instead, we have created a middle-ware solution running on our cloud. In this way, our solution integrates to our cloud to enable data to be published for consumption by other cloud, or on-premises, applications.

 

CLOUD API

 

FEATURES AVAILABLE

  • Project:
    • Publish (export) SI projects and (its change orders) to an integration 
    • Update (import) an existing SI project from an integration
  • Catalog
    • Publish (export) Products to an integration
    • Update (import) Products from an integration 

 

Please note that the old Change Order method (SubscribeCOProjects) is now deprecated. It will still function, but please do not further develop an integration based on the old method (used on SI2017 or older).

 

CONSIDERATIONS

  1. A catalog can contain up to 10000 records.
  2. To access the API, users must be on the latest version of D-Tools. The access with an outdated version is not supported and may not work.
  3. To access the API, users must be enrolled on the Software Assurance (SA) program.
  4. Change Orders. D-Tools can handle change orders from existing D-Tools projects, and export the changes or the updated project to their third-party integration. The integration call works for both projects and change orders. We have an enhanced Change Order function (available on SI2018 or later), and users will likely prefer to manage Change Orders in SI. Here is a link that explains this function: https://support.d-tools.com/001_SI_2018_Documentation/User_Guide/04_Projects/01_Project_Explorer/07_Change_Orders
  5. Installation Task and Service Orders are not part of our API. Based on the general idea of division/separation of software capabilities, installation and service management is likely a feature to be handled on their third-party integration, so it is not a current concern.
  6. Certain features can be disabled in SI, either by the “privileges” (set on each user group) or by the licensing type. However, since D-Tools SI is an on-premises app, users with a full license have complete control, and privileges are managed by each company.
  7. Ideally, a workflow, similar to the one described on this link, should be created in collaboration between our teams: http://www.d-toolsblog.com/implementation-station/suggested-project-workflow-1  - this should help guide our customers on how the integration works and what results are expected if they follow this process along.
  8. Our integration should revolve around integrating projects and updating the projects back and forth as applicable. A good flexibility is to allow users to be able to add items on both applications (there are good use-cases to advocate on those options, and for usability purposes, this should be permitted) but this brings a consolidation concern. A good way to handle this concern is by suggesting users to create or map items only when a project is created in their third-party integration from D-Tools or updated in D-Tools from their third-party integration.
  9. For an initial database matching effort, we would recommend a manual export/import of vendors, clients, and parts; we can use our export/import functionality, available through a CSV file, or bridged through QuickBooks or Outlook. Consecutive pushes/updates should be handled through the project's export and import. We don’t recommend developing code for the initial database creation. There are many variables to how users may want to proceed with this step, and it seems easier to manually perform this initial function.
  10. D-Tools does not handle any accounting operations or inventory capabilities. if using QuickBooks, D-Tools users should consider integrating with QuickBooks through their third-party integration or from D-Tools.
  11. There is an API key associated with each of the license keys. This is required on the calls to the API, as described on the documentation. For information on how to use the API Key, please review the following link: http://support.d-tools.com/API_Support/Administrator_Guide/API_Key
  12. Manage Integrations: For information on how to Manage your integrations, please review the following link: http://support.d-tools.com/API_Support/Administrator_Guide/Manage_Integrations
  13. When a project is exported from D-Tools to their third-party integration, all available information on both the project and itemized project_items is parsed. This includes Project Name, Client Name, Addresses, and for each item, Manufacturer, Model, IP address, Serial Number, Vendor, and many more. For a complete list, please visit:
    1. Project related data: https://api.d-tools.com/SI/doc/ResourceModel?modelName=Project
    2. Project’s items related data: https://api.d-tools.com/SI/doc/ResourceModel?modelName=ProjectItem

 

 

SUGGESTED PATTERN

  1. If the user elects to use the CRM capabilities from their third-party integration, the process will start there
  2. When a user wants to create an SI 2018 project from their third-party integration opportunity, they export their third-party integration Opportunity to SI 2018
  3. In SI 2018, the user selects “New project from an integration”
  4. If not using an initial their third-party integration Opportunity, then, users would create a “New Project” in SI 2018, and the process would start here.
  5. A user manages the project in SI 2018 until he/she is ready to send it back to their third-party integration. This is one of the most important abstractions to consider when developing an integration pattern.
  6. The user will click on “Export” to their third-party integration, and the project is sent to our API
  7. Their third-party integration consumes the project data from our API, and ideally, they would have the flexibility to map the SI2018 project to a new or existing opportunity, and creating their third-party integration project/opportunity accordingly. 
  8. If the user wants to manager Change Orders in SI 2018, they can push each Change Order to their third-party integration. For this capability, users may want the flexibility to push each CO to the same or new opportunity. 
  9. If the user makes changes into their third-party integration project and wishes to update the respective D-Tools project with their information, this is also available. We don’t necessarily recommend this process, but it is available. We don’t recommend it because, from a process perspective, one of the two applications should be elected to make changes to the projects. Nonetheless, it is available.

 

API TESTING

API testing can be performed using Postman Chrome Extension.

Link: http://www.getpostman.com/ 

Please contact our API support and request a test login credential. This information cannot be posted publicly.

Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.