Pathfix allows you to authorize your users and access the data on their behalf. For this purpose, there are 2 types of Keys provided and referenced by Pathfix:
- Public Key
- Private Key
The public key is provided by Pathfix to associate each application with the configured integrations.
This is the application identifier in Pathfix that allows us to identify which application to check for the integration settings within Pathfix.
- Click on Keys on the left nav bar
- Click-to-copy the Public Key
There are times when you will need extra layer of security while accessing this data. This is where the Pathfix Private Key comes into play.
The private_key is also application based and is an added layer of protection that you can apply to your calls to the provider. This can be found in the Keys section
Using the Private Key
Simply include the private_key in the query string parameter, like so:
https://labs.pathfix.com/oauth/method/[provider]/call?public_key=[pathfix public key]&userId=[your app user id]&private_key=[pathfix private key]
When to use the Private Key
Use the private key when additional security is required. These are some scenarios where you can include it:
- When testing API calls in Postman
- When using server-to-server calls
- When you get an error - IP Blocked
You can choose to include the private_key by default to all your calls.
When NOT to use the Private Key
When using the pre-built plugins for Bubble.io you will be asked for the x-partner-key
This can be found in the Keys section
Need additional help? Reach out to us at email@example.com