API CMMS Maintenance Software Integrations & Webhooks

Synchronize Maxpanda Webhooks with your current apps

API Maintenance Integration: What does mAPI stand for? mAPI is a proprietary Maxpanda API software specifically developed to securely transfer data from your Maxpanda CMMS database to other software that also operate on highly secure API web protocols. mAPI Software Integration: Join millions of people like you who seek to manage their work orders online, seamlessly integrating preventative maintenance routines on buildings, vehicles, locations, assets and much more into their existing systems. Maxpanda CMMS Open API (mAPI) is documented using the latest SWAGGER and WEBHOOK tool sets. No support is given with 3rd party customer APIs and there is no additional charge for our API.

The OpenAPI Specification (OAS) defines a standard, language-agnostic interface to RESTful APIs which allows both humans and computers to discover and understand the capabilities of the service without access to source code, documentation, or through network traffic inspection. When properly defined, a consumer can understand and interact with the remote service with a minimal amount of implementation logic. An OpenAPI definition can then be used by documentation generation tools to display the API, code generation tools to generate servers and clients in various programming languages, testing tools and pre-Built pre-Designed Webhooks.

OpenAPI Document: A document (or set of documents) that defines or describes an API. An Open API definition uses and conforms to the OpenAPI Specification. Only Maxpanda Company Admins will have access to mAPI through secure portals.

Private API: A private API is an interface that opens parts of an organisation’s back-end data and application functionality for use by developers working within (or contractors working for) that organization. Private APIs are only exposed to internal developers therefore the API publishers have total control over what and how applications are developed. Private APIs offer substantial benefits with regards to internal collaboration. Using a private API across an organisation allows for greater shared awareness of the internal data models. As the developers are working for (or contracted by) one organisation, communication will be more direct and therefore they should be able to work more cohesively as a group. Maxpanda API significantly diminishes the development time needed to build internal systems that maximise productivity and create customer-facing applications that improve market reach and add value to existing offerings.

Open API: In contrast to a private API, an open API is publicly available for all developers to access. They allow developers, outside of an organization's workforce, to access back-end data that can then be used to enhance their own applications. Open APIs can significantly increase revenue without the business having to invest in hiring new developers, making them a very profitable software application. However, it is important to remember that opening back-end information to the public can create a range of security and management challenges. For example, publishing open APIs can make it harder for organisations to control the experience end users have with their information assets. Open API publishers cannot assume client apps built on their APIs will offer a good user experience. Furthermore, they cannot fully ensure that client apps maintain the look and feel of their corporate branding.

Open APIs in business: Open APIs can be used by businesses seeking to leverage the ever-growing community of freelancing developers who have the ability to create innovative applications that add value to their core business. Open APIs are favored in the business sphere as they simultaneously increase the production of new ideas without investing directly in development efforts. Businesses often tailor their APIs to target specific developer audiences that they feel will be most effective in creating valuable new applications. However, an API can significantly diminish an application's functionality if it is overloaded with features.

Maxpanda Webhooks chart: For example, Yahoo's open search API allows developers to integrate Yahoo search into their own software applications. The addition of this API provides search functionality to the developer's application while also increasing search traffic for Yahoo's search engine, benefiting both parties. With respect to Facebook and Twitter, we can see how third parties have enriched these services with their own code. For example, the ability to create an account on an external site/app using your Facebook credentials is made possible using Facebook's open API. Many large technology firms, such as Twitter, LinkedIn and Facebook, allow the use of their service by third parties and competitors.

Open APIs on the Web: With the rise in prominence of HTML5 and Web 2.0, the modern browsing experience has become interactive and dynamic and this has, in part, been accelerated through the use of open APIs. Some open APIs fetch data from the database behind a website and these are called Web APIs. For example, Google's YouTube API allows developers to integrate YouTube into their applications by providing the capability to search for videos, retrieve standard feeds, and see related content. Maxpanda Webhooks are used for exchanging information with a website either by receiving or by sending data. When a web API fetches data from a website, the application makes a carefully constructed HTTP request to the server the site is stored on. The server then sends data back in a format your application expects (if you requested data) or incorporates your changes to the website (if you sent data).

API is the best way of connecting software engineers and sharing valuable data and developments. Through API, programmers access a network of shared pieces of code and useful experiences. However, to access them, they need clear documentation. It is noteworthy that earlier there was not only no industry standard for developing APIs, but there was no standard for documenting them, either. Swagger emerged as an approach to building APIs and soon became the most popular framework for this purpose. Two years ago Swagger specification was renamed the OpenAPI Specification and moved to the Linux Foundation. What's important, a Swagger framework is supported by such corporations as Maxpanda, Google, Microsoft, and Atlassian. Also, giants like Yelp and Netflix have already used it in their work.

What is Swagger: Swagger is the largest framework for designing APIs using a common language and enabling the development across the whole API life cycle, including documentation, design, testing, and deployment. The framework provides a set of tools that help programmers generate client or server code and install self-generated documentation for web services.

INTEGRATION WITH UNLIMITED BI TOOLS

1. "Scheduled Data File"
2. "File Importer"
3. Clients Development team may consume API / Data files by building their own UI using choice of BI tools

INTEGRATION WITH MAXPANDA API

1. Custom mAPI Integration Layer script creation
2. Maxpanda pre-built pre-designed Webhooks
3. Custom Report Files - an amazing UI for clients to connect storage Accounts such as Google Drive, SFTP, Dropbox, Amazon S3 etc... Includes a UI to schedule data file delivery using an Incremental or Full data stream
4. Schedule API Jobs - Generate files & deliver to client storage account

Webhooks: What are they & what do they do?

Webhooks are one way apps can send automated information to other apps. Its how PayPal tells your accounting app when your client pay you. They are simple way your online accounts can "speak" to each other and get notified automatically when something new happens. In many cases, you'll need to know how to use webhooks if you want to automatically push data from one application to another. Let's break it down and learn how to speak webhook and get your in-house application to talk with Maxpanda application.

What are webhooks?

There are two ways apps can communicate with each other to share information: polling and webhooks. Polling is like knocking on your friend's door and asking if they have sugar (aka information), but you must go and ask for it every time you want it. Webhooks are like someone tossing a bag of sugar at your house whenever they buy some. You don't have to ask; they just automatically punt it over every time it's available. Webhooks are automated messages sent from apps when something happens. They have a message-or payload-and are sent to a unique URL-essentially the app's address. Webhooks are almost always faster that polling and require less work on your end.

They're much like SMS notifications. Say your bank sends you an SMS when you make a new purchase. You already told the bank your phone number, so they knew where to send the message. They type our "You just spent $00 at NewStore" and send it to your phone number +1-234-567-8901. Something happened at your bank, and you got a message about it. All is well. Webhooks work the same way. Technically, Webhooks are "user-defined callbacks made with HTTP". Webhooks are data and executable commands sent from one app to another over HTTP instead of through the command line in your computer, formatted in XML, JSON. They're called webhooks since they're software hooks - or functions that run when something happens - that work over the web. And they're secured with a key or signature sent in the HTTP headers. Webhooks are used to connect two different applications. When an event happens on the Maxpanda (or trigger) application, it serializes data about that event and send it to a webhook URL from the action application - the one you want to do something based on the data from the Maxpanda application. The action application can then send a response to Maxpanda application with HTTP status code like 200 if data was received successfully or 404,500 etc. if not.

Webhooks are similar to APIs-but simpler. An API is a full language for an app with functions or calls to add, edit, and retrieve data. The difference is, with an API, you have to do the work yourself. If you build an application that connects to Maxpanda with an API, your application will need to have ways to ask the Maxpanda app for new data when it needs it. Webhooks, on the other hand, are for one specific part of an app, and they're automated. You might have a webhook just for new Asset - and whenever a new Asset is added, Maxpanda will push the data to your application's webhooks URL automatically. It's a simple, one-to-one connection that runs automatically.

Test your Maxpanda Webhooks on Webhook.site

First, visit https://webhook.site to get a unique Webhook URL. Create your own HTTP request endpoint for your own application.

Open your Profile in Maxpanda and Make sure that you have access to use mAPI. Navigate to Navigation bar and open mAPI and then Webhooks. And Click Add button to add a new webhook on the main page.

Provide a friendly Label and input the Webhook URL for your application and then select events which would trigger/push data to your application/webhook URL. Click Save.

To find the documentation for the payload which will be sent when the webhook will trigger simply follow the existing swagger documentation and mAPI documents provided.

Open the same webhook in Edit mode to check the webhook signature which has been provided.

In Edit mode you can check the X-Webhook-Secret header which will be sent to your webhook URL as a security measure to make sure that your application should match this header value when you receive any request on your application to protect from spam and malicious actors. You can always regenerate a new Secret which would make previous Secret invalid. Under the Recent Requests Section, you will be presented with recent requests made to your webhook URL.

Create a new Building in Maxpanda. And you will receive data on you webhook URL. In the request headers X-Webhook-Secret is sent for your application to verify if this request was indeed from Maxpanda or not. Also, in payload each Maxpanda module is defined by its Entity name in this case as "EntityName":"building" also to let your application know what happened or what triggered. Maxpanda is also sending "EventOperationType":"create" or update or delete. Such that your application also knows what to do with this data. And in the "Body": you will find the same JSON data payload that is provided in the Swagger documentation for each existing API.

Review the history of the requests processed at Recent Requests Section. Click "View Request Details" to check the actual request made and the response sent by your app.

VOILA!

Maxpanda has everything you and your team require to ensure successful Maintenance & Operations

• $0 Setup: Manually upload all your data using Maxpanda Spreadsheets. Upload unlimited buildings, locations, assets, parts and bins in seconds
• Unlimited Users: We know your not used to hearing this but yes, there are no user fees whether you have 2 or 20,000 Users
• Reservations: User may reserve a room, location or asset using a shared calendar between the entire Site
• A Site is an infinite number of Buildings, Locations, Assets and Users. Sites (databases) are operated autonomously within the corporate umbrella
• Lists, Calendars, Maps: View and manage multi status work orders through color coded lists, calendars and live GPS maps
• GoMAX Mobile CMMS App: Built for any iOS/Android smartphone, ipad, tablet including Online or Offline
• GoMAX Mobile GPS: Generate Work Orders in the field with captured GPS location for quick identification
• Parts Inventory: Manage unlimited parts per Site updating quantity, QR/Bar coded for GoMAX, low level notifications and auto Purchase Order generation
• Help Desk A: Any registered user may submit work order requests through desktops and mobiles for follow up through email and push notifications
• Help Desk B: Each Site includes a customized guest portal form for anyone in the world to submit requests placing a link on your website or printing its QR Code
• Staff & Vendor Rating: Rate staff and vendors per work order on desktops/mobiles even through the Guest Portal
• Teams: Create groupings of staff as teams to quickly assign the same team to any work order, metering type or scheduled preventive maintenance
• Teams: Create groupings of staff as teams to quickly assign the same team to any work order, metering type or scheduled preventive maintenance
• Asset Management with Metering: Generate work orders on Assets based on a calendar or defined triggers such as runtime, miles, kilos
• Asset Allocation: Manage your all your Assets from head office. Send Assets to various location around the world and track them by where, who, what, when
• Preventative Maintenance + Task Management: Generated Calendar & Dynamic work orders on a set number of days after last work order completed
• Task Groups: Develop your list of Task Groups - A Task Group include multiple Tasks that can be assigned to mulple staff/vendors
• Scheduled Reporting: Generate instant reports for print/download/share or schedule them on a Weekly Monthly basis
• Purchase Orders, Service Type Purchase Orders, Purchase Order Templates
• Vendor Management: Invite unlimited 3rd party contractors to your account. Assign them to work orders, let them invoice you

· Save $600/year on annual subscriptions · cc charged upon completing 7 day trial (upgrade downgrade cancel anytime)