My API call with Shipworks authentication

This article demonstrates setting up a My API endpoint that authenticates ShipWorks HTTP requests.

The instructions below build on the steps to create a My API that runs an export in Set up My API to run an export. It also uses Postman to request the My API endpoint, similar to Test an export via My API HTTP request except with the ShipWorks advanced settings.

Contents

• A. Get the URL to the My API ShipWorks endpoint
• B. Submit the request
• See full example

A. Get the URL to the My API ShipWorks endpoint

1. In integrator.io, return to Resources > My APIs. 
2. Open the custom endpoint Demo – ShipWorks auth. 
3. Click Enable ShipWorks authentication and supply your ShipWorks username and password.
4. Copy the URL shown in the Advanced > Invoke field.
5. Save and close the My API.

With the ShipWorks option, you do not need to generate an API token and send it with the request. 

B. Submit the request

1. In Postman, paste the Invoke URL into the GET request field. 
2. In the Body tab, select the type x-www-form-urlencoded.
3. Continuing in the Body tab, enter key-value pairs for the username, password, and body, according to your credentials and expected content.
4. Click Send.
5. Verify the export (Shopify records shown).

See full example