Prokeep API

This article provides a basic overview of what can be done with the Prokeep API, how to enable it, and how to monitor it.

Prokeep API

The Prokeep API will allow you to:

  • Message customers based upon a trigger by your 3rd party software
  • Notify a customer that their order has been placed in a locker
  • Update a customer on shipping information
  • Message a receipt after an order has been completed
  • Share contact details between Prokeep and your 3rd party software such as your CRM or ERP

For full documentation on the available functions of the API, check out the technical docs.

Generating API credentials: 

API credentials are separate from your login credentials for Prokeep.

 A Prokeep admin on your account will need to generate a generic set of credentials that can be used to call our API. These credentials are created and managed in Settings

  1. In Settings, click on API. 
  2. On the API page, click on Create Application. When prompted, give your application a Name. You can create as many applications here as you would like, and it’s highly recommended to create an application for each external system that will be calling the Prokeep API. 
  3. Once your Application is created, click on Generate Credentials. Copy the Username and Password provided, and click Confirm. We do not show the password again once the credentials are confirmed, so be sure to save it somewhere else before then. Prokeep API uses basic authentication.
    1. The Credentials are not active until the admin has clicked confirm 
    2. If you lose the credentials after you’ve confirmed them, you can regenerate them by clicking Revoke Credentials. This will let you generate new credentials for that API application. 
  4. You can rename your applications by simply clicking on the application name. 

Note: All API-driven actions taken in Prokeep will be tied to this application for reporting purposes. 

Monitoring the API: 

Once you generate credentials for the application, you will notice a new button for that application that reads Open API Logs. Clicking on that button will take you to the API log page. Here you can view a record of all the API and webhook events associated with that application, as well as their status: successes, failures, and the codes to let you know what went wrong. 

API-Generated Message Reporting: 

If you are only interested in seeing a list of contacts sent a text or email from the API, you can download a comprehensive list with our Reporting Export. Once the API is enabled for your account, you will see an API tab in your reporting export. That tab has a list of all the messages sent in the report’s timeframe, who they were sent to, and what application sent them. 

For more information setting up recurring reports, click here