When you connect Pitchly to your website you're putting your work on display. Let everyone see what makes your business a step above the rest.
Application Programming Interface or API - a tool that defines how two different software components should interact with each other. Create a path between systems by generating a secure API key.
An API key is a secure method of unlocking the path from Pitchly to another software component so the data you place in Pitchly can be shared through the software of your choosing.
GIVE CUSTOMERS AN INSIDE LOOK | SHARE ACHIEVEMENTS | SHOW OFF YOUR BEST SIDE
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.
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”
Located in your account settings.
This will generate your API key popup. Any established API keys will be found in here.
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.
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.
How the connection interacts.
For example: “Updating our website with new and existing organizational achievements.”
This can be updated at any time after the API key is generated.
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.
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.
API keys will be listed in chronological order and can be edited by clicking into the key set.
In the Edit Key Set popup window, you can change the App Name, App Description, and Permissions as needed throughout the life of the key set.
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!
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!
To rotate keys with zero downtime, we alternatively recommend creating a new set of keys, transitioning all instances of this key in your applications to the new key, and then removing this key completely once you have verified all of your applications are working with the new key.
You will use the App ID and App Secret to create .
To regenerate the App Secret click the located directly next to the hidden App Secret.
API keys will be listed in chronological order and can be edited by clicking into the key set.
In the Edit Key Set popup window, you can change the App Name, App Description, and Permissions as needed throughout the life of the key set.
Best practices for updating the App ID and App Secret.
Generating an App Secret will cause all API calls using the old secret to fail, and may break your existing applications!
We recommend creating a new set of keys.
Transitioning all instances of this key in your applications to the new key.
Verify all of your applications are working with the new key.
Lastly, remove this key completely.
The App Secret will only be displayed this once and will never be displayed again, so save both the App ID and App Secret to a secure location. If you lose your App Secret, you must generate a new one, which you can do by editing a Key Set.
There are six different ways of interacting with your Pitchly account.
To regenerate the App Secret click the located directly next to the hidden App Secret.
To regenerate your App Secret click the located directly next to the hidden App Secret when you click into your key set.
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.
