Versions Compared

Old Version 25

changes.mady.by.user Shannon Jones

Saved on

compared with

New Version Current

changes.mady.by.user Shannon Jones

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Info
iconfalse

Our APIs give third-parties the ability to easily integrate with the OPS-COM platform. 

Table of Contents


OperationsCommander (OPS-COM) has made APIs (Application Programming Interface) available that allow for authenticated third-parties to access and manipulate data in OPS-COM as needed. This enables the accomplishment of specific functions, such as the ability to add valid permits from pay-and-display machines.

What is an API?

APIs, or "Application Programming Interfaces," are specially-designed channels for communication between software systems. Essentially, they give programmers the ability to connect your custom software application to an external system, whether it is running within your office space or out in the cloud.

When you have multiple software systems within your business, it can require a lot of duplicate data entry, which costs you time and money. The API integration project aims to save you money by reducing excess data entry by making it easy for your staff to maintain multiple databases from a single location. 

Vendors program APIs into their software to allow external developers to access and manipulate their data. The third-party integration project aims to utilize these systems to eliminate excess data entry and provide new features to the software.

Show if
special@authenticated


Support Agent Notes

Terminology and Page Naming

Pages should start with the direction and source of flow of data. Then followed by a dash and the content type. i.e. "Export Task: User" or "Push API: Permit Create". Each word has a specific meaning:

Push APIAn API exposed to third parties where they initiate the communication and push information to us. Information is packaged up in a JSON object and sent to us to process.
Pull APIAn API where third parties initiate the communication and pull information from us. Anything submitted to us is only to filter the results but we package the information and send it back to them.
Export TaskWe run a scheduled task that generates data from our system and creates a file to be picked up by FTP or sent directly to the client or a third party. We initiate the data transfer.
Import TaskA file is expected to be in a specific location, uploaded by the client. We run a scheduled task that checks for this file and imports the data should it exist. Except for the uploading of the file, we initiate the data transfer.  

We can also talk directly to their system as we do with T2. It's still initiated by us, but it doesn't really need to be a file.





Note

Please note this documentation is specific to APIs we have developed for third-parties to connect to OPS-COM.

We also offer API integration for other third-party hardware and software vendors.

API Supported Functionality

Child pages (Children Display)


Show if
special@authenticated

Related Pages

Left out related pages intentionally since it doesn't make sense on a page that displays the child links in a TOC fashion



Show if
special@authenticated


Support Agent Notes

In order for a client to use this, they would need to have paid for the right to integrate with OPS-COM, have been issued an API Key, and had their integration validated for testing with us.