How-To: Configure PIMS API Settings

How-To: Configure PIMS API Settings

In order to utilize PIMS integration, Weevio Cloud needs to be able to connect to your PIMS server. You'll need to gather the following: the static public-facing IP or URL address of your PIMS server, the HTTPS port of your PIMS server, create a PIMS user/password with API permissions, etc.

If you don't already own the PIMS Web Services Module and a 4D Web Application Expansion License, you will need to purchase these in order to make use of the PIMS API connection.  Please contact support@weevio.co to get a quote for these items.


Configure PIMS for API Connection:

Step 1:

Find the static public-facing IP or URL of your PIMS server.

Important: If you are using an IP address, verify that your IP address is static. Otherwise, it might change and break your connection to your server.


Step 2:

Configure your PIMS server's HTTPS port (typically 8443), then configure port forwarding on your firewall.

Under Web > Configuration, set your HTTPS port.

Step 3: Create API User Account

Inside your PIMS Client, select File > PIMS Tools... Then select Passwords/Groups.

Click the + button to create a new PIMS API user with random username and random 15 character password.

Under the permissions area, checkmark "Member" for all options.




Step 4:

Open Terminal (on Mac), generate SSL certificate using: 

openssl req -nodes -new -x509 -keyout key.pem -out cert.pem -days 1825
After entering the above command in Terminal, it will ask you a series of questions:
  • Country Name (2 letter code)
  • State or Province Name (full name)
  • Locality Name (eg, city)
  • Organization Name (eg, company)
  • Organizational Unit Name (eg, section)
  • Common Name (eg, fully qualified host name)  — i.e. domain name or public static IP address of PIMS server.
  • Email Address
Please Note: cert.pem and key.pem are typically outputted to your home directory, unless you specifically changed the directory before running the command.

Navigate to your PIMS Server directory, then right-click on the PIMS Server app and select "Show Package Contents..."

Then copy the key.pem and cert.pem into the "Server Database" folder.
Right-click, then select "Show Package Contents"
Copy the key.pem and cert.pem into the "Server Database" folder.

Step 5:

Download PIMS WEB Plug-Ins.


After downloading, navigate to your PIMS Server folder > WEB Plug-Ins, unzip, and copy plug-ins into the WEB Plug-Ins folder.
Once copied, open your PIMS Client and navigate to File > ExecUtron Account Functions > Update Users/Modules from EDC...


Then click the DONE button.






Step 6:

Inside your PIMS Client, navigate to File > Web Services Module...

Once inside the WEB Services Module, navigate to iOS/WEB Server > Preferences...

Inside the API ACCESS PASSWORD field, enter the same password you created in Step 3 (for your API user account).

Then click "Generate" underneath the API ACCESS TOKEN field.



Add PIMS API Credentials to Weevio Cloud

1. Log into https://cloud.weevio.co.

2. If no location is selected, please choose a location from the location modal. It doesn't matter which location you choose for this procedure as all the settings we will be configuring are global.

3. Click Integrations in the left-side navigation.

4. Click the Connect button on the PIMS integration card.

5. You'll be taken to the PIMS API Connection settings page. In the Server URL field, enter the public static IP for your MAIN PIMS server.

6. In the Server Port, enter the port that you have forwarded to your MAIN PIMS server.

7. In the API Username field, enter the username of the PIMS user you set up for API access.

8. In the API Password field, enter the password of the PIMS user you set up for API access.

9. In the API Token field, enter the API token you had PIMS generate for you in the Web Services Module.

10. Click the Save button to save the settings.

11. Weevio Cloud will attempt to connect to your PIMS Server. If successful, you'll see a green success banner and a Connected label at the top of the page.

If unsuccessful, you'll see an orange banner alerting you to an issue with your settings. Double-check that you entered all the information correctly and try again. If you've confirmed that the information is correct, and things still aren't working, we recommend confirming that the port you entered in the Server Port field is actually open and forwarded to your PIMS server.

12. Once connected, click on Settings in the left-hand navigation.

13. Click Manage Locations under Settings in the left-hand navigation.

14. Make sure all the locations you want the API to interact with are listed. If you are missing any locations you can click the Add Location button to add additional locations.

15. Expand each location and select the corresponding PIMS Location Code for each location.

16. Once you have added all locations and confirmed that their information is correct, click Save.

17. A modal will appear asking you to confirm. Click the Save Locations button.




    • Related Articles

    • Configure SMTP Settings for Weevio Apps

      Overview Due to changes being implemented by Amazon Web Services, we will no longer be able to host an SMTP service to send the various emails that come from our apps. Going forward, each company will need to use the SMTP service from their own email ...

    • Sync Products from PIMS to Shopify

      Overview This article provides step-by-step instructions on how to sync products from PIMS to Shopify. It covers important details such as ensuring accurate data, adding variant products, customizing product information and images, and ...

    • Configuring GSX User Credentials in PIMS

      Overview With the launch of the RESTful GSX APIs, Apple changed authentication to a user-based tokenized system.  Rather than have a PIMS Administrator manage the credentials for all GSX users, ExecUtron added the ability for each user to manage ...

    • Add a Shopify Product Type to PIMS

      Overview This guide provides step-by-step instructions on how to add a Shopify Product Type to PIMS. By following these steps, users can easily integrate their Shopify products into PIMS, allowing for better inventory management and organization. ...

    • Updating your GSX API Token for Weevio Scheduler & Notifier

      Overview With the launch of the RESTful GSX APIs, Apple changed authentication to a user-based tokenized system. Starting May 31, 2022, GSX Web Services will limit the maximum duration of token exchanges that may be performed through the token API. ...