Introduction To Extensibility Guide

Katapult Pro has its own application programming interface (API) so that you and your team have developer access to the platform in a way that allows you to programmatically extend it to connect with other software your business utilizes in your workflows. This introduction to Katapult Pro's extensibility is friendly for beginners who want to explore ways to truly sculpt Katapult Pro to your needs and unique circumstances.

Included are the options for extending the platform: API web tools that can be run on the Map page, creating custom pages for the App Tray that link outside (and inside) of Katapult Pro, and the API resources available for exploring these options.

API Resources

The API Resources on the Home page equips those with little to no experience with API to explore how to use the platform’s API features to bring the Katapult Pro platform into other software and parts of your workflow, while the "Api" widget allows you to generate your own API key to access the API. (Your company admin will need to ensure that you have API access. Instructions for how they can do this will be found in the Company's User Information Permission section of the Admin Page Guide.)

Adding The API Widgets

1. Click the “EDIT WIDGETS” button at the top of the Home page to open the widget library

   

2. From here, click the blue “+” in the corner of API Resources; be sure to add the API Widget so you can generate an API Key that allows you access to the API

                 

Your API Key is sensitive information and should not be shared with anyone else.

What’s Included:

In the API Resources widget you'll find...

• Links to API documentation that list our API calls at your disposal and how they work
  • Start with the latest version
• Links to documentation for creating your own web tool with a platform-as-a-service (PaaS) such as Render or Cloudflare
• Link to a Google sheet that aids in exploring how Katapult Pro's API can be leveraged
  • Video as additional guidance for demonstrating how to use it
• Section for testing API calls with an example job (or using your own)

API Web Tools

With other tools on the Map, you can create a mapping tool that, when clicked, will...

1. Run an API Call
   • We have two articles that show how to use Python and Render or Cloudflare Workers to run an API Call in Katapult Pro
2. Run the API Endpoint in a new tab
3. Run the API Endpoint in an embedded window
   • Learn the different aspects of the iFrame that are in your control

Custom Pages for the App Tray

Add your own pages to the App Tray menu that will take you directly to other pages within Katapult Pro (not already in the App Tray) or to external sites, whether for reference or for the next part of your workflow.

To get started, navigate to the Project Management page in Katapult Pro and find the “Extensions” section with “Custom Pages” found underneath.

Click the blue “+” to start creating your custom page for the App Tray.

Once you’ve chosen a name for the new page, click “Continue.”

There are two steps for creating your custom page: 

1. Set the style for your tool by choosing an icon and selecting a color
2. Enter the URL that the page should link to

If you’re using an external URL, make sure to enter ‘https://’ first, otherwise the software will append the URL to your Katapult Pro domain. Note: anyone in your company can see the URL you enter.