How To: Setup and Use Pronto API Step by Step – Pronto Support

This article outlines a series of steps to do the following:

How to setup and use Pronto API parameters, values and requests.

Pre-requisites:

1. Tenant admin only can create API-key.

2. Users can not view the data using API-key even though they have access using basic auth, only Administrators can.

3. API Environment (Post man is being used in this example).

Variables

In the API example articles, variables with {{API_HOST}} should be replaced with the full host URL hostname:

https://api.gopronto.io/api/v1/

Setup and Use Pronto API

1. Create API requests you wish to use in your API environment. In this case we are using Postman, and we will use a GET request for a contact within Pronto.

2._getdetailscontact.png

2. Next we need to set the Authorization type. Navigate to the Authorization tab and select API Key from the Type drop down menu.

3._authorizationselectapikey.png

3. Type X-API-KEY in the Key field. Note: Case does not matter but it is imperative you use the hyphens.

4._writexapikey_-_can_be_any_case_but_needs_to__be_x-api-key_with_hyphons.png

5. Navigate back into your Pronto environment. Select API Keys in the menu bar on left side, click Generate API Key in the top right hand corner.

5._Select_API_Keys_in_menu_bar_on_left__generate_api_key.png

6. Name the API Key and click Save.

6.__name_it_api_key.png

7. After saving a new box will appear with the API Key. Select the Copy All icon and do not close until you are sure the key was copied to the clipboard.

7.__Click_Save_and_Copy_the_API_Key.png

8. Paste the API key in the Value and Header is selected in Add To.

8._Paste_API_key_in_Value_of_header.png

9. Navigate to Params (Parameters).

9._Navigate_to_Params__Parameters_.png

10. Under Key type api_key_email.

10._In_Key_type_api_key_email.png

11. The Value will be the email of the user you are logged into pronto as currently.

11._The_value_will_be_the_email_of_the_user_you_are_logged_in_pronto_as__you_will_then_navigate_to_a_relationship_card__contact_you_want_to_get_using_the_api.png

12. In Pronto, navigate to a relationship card that has contacts to get the contact ID from a contact you wish to test the API on.

12._Navigate_to_the_relationship_card_to_get_the_contact_ID_from_the_contact..png

13. Select a contact from Sales > Contacts.

13._Select_a_contact_from_Sales_Contacts.png

14. Copy the contact ID from the URL as seen in the image below.

14._Grab_the_contact_ID.png

15. Go back into Postman and paste the contact ID here in postman.

15._Paste_the_contact_ID_here_in_postman..png

16. Select the environment, in most cases app.gopronto.io or a test environment if you have a sandbox environment you are testing in.

16._Select_the_environment__in_most_cases_app.gopronto.io_or_a_test_environment..png

17. The environment hostname goes here, again app.pronto.io or the hostname of the test environment.

17._The_environment_hostname_goes_here__again_app.pronto.io.png

18. You can run the API and open inspector at the same time to follow the api request. Open the window where you selected the Contact in Pronto. Click the three dot menu icon in your browser and select Dev Tools under More Tools, then select the Network tab. Once you have done so click Send in the Postman window. You should see the API successfully run in the Pronto window.

18._You_can_run_the_API_and_open_inspector_at_the_same_time_to_follow_the_api_request.png

19. You can send it from postman as well and validate if it is working and we see it is s we are returned the data in this case the contact info from the GET API request.

19.__You_can_send_it_from_postman_as_well_and_validate_if_it_is_working_and_we_see_it_is_s_we_are_retruned_the_data_in_this_case_the_contact_info_from_the_GET_API_request.png

This article outlines a series of steps to do the following:

Pre-requisites:

Variables

Setup and Use Pronto API

Related articles