Creating an API Key

Creating an API Key in your Pitchly account can be done with just a few clicks. This allows the application of your choice to seamlessly share information across platforms.

Click on the account settings button

You’ll find this in the upper right-hand corner of your Pitchly account.

The name is different for each organization.

In this example, our account is called “Basic Pitchly”

Click on API keys

Located in your account settings.

This will generate your API key popup. Any established API keys will be found in here.

Select, Create new key set

Located at the bottom of the popup window.

Creating a new key set will generate the information you need to connect Pitchly to the application of your choice.

Name your API

This can be anything, but it’s best to make it specific. The name should show other team members what the API key interacts with.

Describe the purpose of the API key

How the connection interacts.

For example: “Updating our website with new and existing organizational achievements.”

Define the permissions between Pitchly and the application

This can be updated at any time after the API key is generated.

Permission definitions

Click, Create to generate your App ID and App Secret

You will use the App ID and App Secret to create API Calls.

API Call Defined: the process that takes place after the API is set up and ready to go.

Create a call for WordPress: Get an API key from Pitchly. Create a Plugin for adding a widget to your WordPress site. Customize your plugin with your Pitchy API key and specific information you want to display in the widget. Use the WordPress Admin Area to place the widget on your site where you want it within your theme.

Tips and Tricks

Name

Where

How

readData

Allow the App to read data from databases in an organization.

insertData

Allow the App to insert new records into a database.

updateData

Allow the App to update existing records in a database.

deleteData

Allow the App to delete existing records from a database.

addFields

Allow the App to add fields to the structure of a database.

readMembers

Allow the App to read information about users in an organization.

Before generating an App Secret you will need to replace all instances of the old Secret in your applications with the new one.

Generating an App Secret will cause all API calls using the old secret to fail, and may break your existing applications!

Last updated

Was this helpful?