Difference between revisions of "Create API Keys"

From docs
Jump to: navigation, search
 
Line 1: Line 1:
 +
CallProof provides APIs that allow third-party applications to securely access data from your CallProof account.
  
CallProof has APIs in place to poll data from 3rd Party Sources.  
+
To enable this access, you must create an API key. These credentials can then be used by third-party applications, such as Zapier or other integrations, to access your CallProof data.
  
To allow this access, users must create API keys for their account.  Using these keys, 3rd Party Sources can access your data from outside the CallProof website/mobile app.
+
== API Information ==
  
To create these keys, log into your CallProof account.
 
<div style="clear:both;"></div>
 
 
[[File:01_callproof_api_tool.png|300px|thumb|right|API Tools in CallProof]]
 
[[File:01_callproof_api_tool.png|300px|thumb|right|API Tools in CallProof]]
== Navigation ==
 
  
'''Home''' &rarr; '''Tools''' &rarr; '''API'''
+
'''Navigation:''' '''Home''' &rarr; '''Tools''' &rarr; '''API'''
  
 
# Log in to your CallProof account.
 
# Log in to your CallProof account.
 
# From the main navigation bar, hover over '''Home'''.
 
# From the main navigation bar, hover over '''Home'''.
 
# In the '''Tools''' section of the drop-down menu, click '''API'''.
 
# In the '''Tools''' section of the drop-down menu, click '''API'''.
 +
# The '''API''' page opens.
  
 +
<div style="clear:both;"></div>
  
 +
== API Keys ==
  
<div style="clear:both;"></div>
+
[[File:02_callproof_api_keys.png|300px|thumb|right|API Keys]]
[[File:02_callproof_api_keys.png|300px|thumb|right|Select API Keys to Create New Key]]
 
== API Keys ==
 
  
'''Home''' &rarr; '''Tools''' &rarr; '''API''' &rarr; '''API Keys'''
+
'''Navigation:''' '''Home''' &rarr; '''Tools''' &rarr; '''API''' &rarr; '''API Keys'''
  
# Log in to your CallProof account.
+
# On the '''API''' page, locate the '''Quick Links''' section on the right.
# From the main navigation bar, hover over '''Home'''.
+
# Click '''API Keys'''.
# In the '''Tools''' section of the drop-down menu, click '''API'''.
+
# The '''API Keys''' page opens, where you can view and manage your API keys.
# The '''API''' page opens.
 
# On the right side of the page, click '''API Keys'''.
 
# The '''API Keys''' page opens, where you can create and manage your API keys.
 
  
 
<div style="clear:both;"></div>
 
<div style="clear:both;"></div>
[[File:03_callproof_api_new.png|300px|thumb|right|Create New API]]
+
 
 
== Add API Key ==
 
== Add API Key ==
The next screen will show any existing API Keys and allow you to create a new one.  Select '''Add API Key''' to create a new key.
 
  
'''Home''' &rarr; '''Tools''' &rarr; '''API''' &rarr; '''API Keys'''
+
[[File:03_callproof_api_new.png|300px|thumb|right|Add API Key]]
  
# Log in to your CallProof account.
+
'''Navigation:''' '''Home''' &rarr; '''Tools''' &rarr; '''API''' &rarr; '''API Keys'''
# From the main navigation bar, hover over '''Home'''.
+
 
# In the '''Tools''' section of the drop-down menu, click '''API'''.
+
# On the '''API Keys''' page, click '''Add API Key''' at the top of the page.
# The '''API''' page opens.
+
# The '''New API Key''' page opens.
# On the right side of the page, click '''API Keys'''.
+
# Enter the required information in the form.
# The '''API Keys''' page opens.
 
# Click the '''Add API Key''' button at the top of the page.
 
# The '''New API Key''' page opens, where you can create a new API key.
 
  
 
<div style="clear:both;"></div>
 
<div style="clear:both;"></div>
[[File:04_callproof_api_savekey.png|300px|thumb|right|Save New API Key]]
 
== New API Key Save ==
 
The new key will be displayed.  Click SAVE to save this key.  Keep these 2 strings handy if you are going to use Zapier or another API solution to grab CallProof data from your account.
 
  
'''Home''' &rarr; '''Tools''' &rarr; '''API''' &rarr; '''API Keys'''
+
== Save the API Key ==
  
# Log in to your CallProof account.
+
[[File:04_callproof_api_savekey.png|300px|thumb|right|Save API Key]]
# From the main navigation bar, hover over '''Home'''.
+
 
# In the '''Tools''' section of the drop-down menu, click '''API'''.
+
'''Navigation:''' '''Home''' &rarr; '''Tools''' &rarr; '''API''' &rarr; '''API Keys'''
# The '''API''' page opens.
+
 
# On the right side of the page, click '''API Keys'''.
+
# Review the information you entered.
# The '''API Keys''' page opens.
+
# Click '''Save'''.
# Click the '''Add API Key''' button at the top of the page.
 
# The '''New API Key''' page opens.
 
# Enter the required information in the form.
 
# Click the '''Save''' button.
 
 
# The new API key is created and displayed in the '''API Keys''' list.
 
# The new API key is created and displayed in the '''API Keys''' list.
 +
# Save the generated credentials in a secure location. These credentials are required when configuring integrations such as Zapier or other third-party applications.
 +
 +
<div style="clear:both;"></div>

Latest revision as of 05:45, 14 July 2026

CallProof provides APIs that allow third-party applications to securely access data from your CallProof account.

To enable this access, you must create an API key. These credentials can then be used by third-party applications, such as Zapier or other integrations, to access your CallProof data.

API Information

API Tools in CallProof

Navigation: HomeToolsAPI

  1. Log in to your CallProof account.
  2. From the main navigation bar, hover over Home.
  3. In the Tools section of the drop-down menu, click API.
  4. The API page opens.

API Keys

API Keys

Navigation: HomeToolsAPIAPI Keys

  1. On the API page, locate the Quick Links section on the right.
  2. Click API Keys.
  3. The API Keys page opens, where you can view and manage your API keys.

Add API Key

Add API Key

Navigation: HomeToolsAPIAPI Keys

  1. On the API Keys page, click Add API Key at the top of the page.
  2. The New API Key page opens.
  3. Enter the required information in the form.

Save the API Key

Save API Key

Navigation: HomeToolsAPIAPI Keys

  1. Review the information you entered.
  2. Click Save.
  3. The new API key is created and displayed in the API Keys list.
  4. Save the generated credentials in a secure location. These credentials are required when configuring integrations such as Zapier or other third-party applications.