Postman is an app available to developers as a tool to share, test, document & monitor APIs. Get Postman . Making….
Find instructions specific to obtaining authentication credentials to the Share A Refund API within the developer section of this help center.
Postman is an app available to developers as a tool to share, test, document & monitor APIs. Get Postman
Get started with using Postman to send and receive through the Share A Refund API with the following steps:
Both the native application and the browser extension have been tested and work for the example below.
https://api.sharearefund.com/beta/customer/shipment-price
https://api.sharearefund.com/beta/reseller/shipment-price
Note: Explore methods within the API Docs
A minimum of two Headers are required to make a request of any type.
Header: Content Type
Key: Content-Type
Value: application/json
Header: x-api-key
Key: x-api-key
Value: YOUR-API-KEY
API keys are unique and available upon request. More information on obtaining an API Key is available within the Developer area of the Share A Refund help center.
The figure above showcases the location within Postman to enter the required Header values defined in this section.
For post request types, required parameters are made in json format.
The figure above. showcase the raw body input and associated parameters required.
Access to shipping accounts and related tracking numbers are specific to your account and the privileges defined by user type. Ensure that you’re using a valid tracking number that’s available within your Share A Refund account.
Tap the send button to submit the post request provided in this example.
The figure above showcases an example reponse for the shipping price method.
Ensure that the access key matches the values defined for your account, and that the requested endpoint is indeed valid.
Ensure the URL used in making the request, is valid for the your user type.
Ensure that formatting of the body input is valid json and matches the parameters defined for the method requested.
Put X-API-Key in header In C# and various languages, the key must be placed into the header. Also, try the…
API credentials can be requested from inside your account and through contacting customer service.
In C# and various languages, the key must be placed into the header. Also, try the following statement when making a test request.
request.Headers.Add(“x-api-key”, “YOUR_API_KEY”);
Note: Rather than adding x-api-key in the post data.
Ensure that a successful connection is made is Postman. Related articles below provide a step-by-step guide.
Domestic and International shipping services to 200+ destinations.
