Postman is a tool for running HTTP requests. It provides a handy UI for easily defining the parameters and other request data. If you do not already have Postman, you can get it here for free.
Pre-requisites
-
You must have created a CauseActive Platform Collection.
-
You must have generated API Credentials for that Collection.
-
You will need the apiKey and apiSecret values to authenticate your API requests.
-
You must have created a CauseActive Platform Campaign.
-
If you open the edit panel for the Campaign, you can get easy access to the API Endpoint URL you will need in order to generate Donation Links for it.
-
The URL will look something like:
https://go.causeactive.com/api/v3/donation-link/123/donor-id-here
Configuring and Sending a Request in Postman
-
Create a new Postman Collection
-
A name like "CauseActive Platform" would be appropriate.
-
Create a new Postman Request inside the new Postman Collection you just created.
-
Set it to the POST request type.
-
Copy the API Endpoint URL you obtained previously and paste that into the address bar for the Postman request.
-
Click the Body tab and choose form-data.
-
Create entries under “Key” for apiKey and apiSecret
-
Set their values to the corresponding API Key and API Secret values you generated previously.
-
Send the request.
You should get back a response matching one of those outlined in the Donation Link End-point Specification.