Create the V-TECH Endpoints

The following steps create the V-Tech Endpoints needed to integrate Acumatica with
StarShip Online (Cloud). Before starting, make sure that you download the required V-TECH Endpoints ZIP file.

See the Supported Versions page to check what version of the V-Tech Endpoints you should download.

Download the VTechEndPoints File

If you haven’t done so already, you will need to download the V-Tech Endpoints file. To do this, log in to your StarShip Subscription to access the file.

After logging into your account in the StarShip Subscription Management system, select the Downloads menu item.
Select the Acumatica page heading and download the VTechEndpoint file specified for the version of Acumatica you are currently running.

Note

To clarify, VTechEndPoint V5 is designed for integration using the Simple Object Access Protocol (SOAP), while VTechEndPoint V6 is designed for integration using Representational State Transfer (REST).

Browser Notes

Google Chrome

When downloading the ZIP file, Chrome will display a message in the bottom-left that says "VTechEndPoint...zip is not commonly downloaded and may be dangerous." To move forward, click on the up arrow on the side of the Discard button and click Keep. When the download is complete, you can use the Show in Folder option, which brings you to the Downloads folder. Or you can go directly to the Download folder.

Mozilla Firefox

When downloading the ZIP file, Firefox displays a window with the option to open or save the file. Select "Save File". After the download is complete, check your Download folder for the ZIP file.

Microsoft Edge

When downloading the ZIP file, Edge displays a message at the bottom of the screen asking "What do you want to do with VTechEndPoint.zip? From: name of (StarShip Online location), click the up arrow and select Save As. You can then select the location where you would like the file to be downloaded.

Attention: Users creating Endpoints for the first time should follow the procedure
on this page. If you already use StarShip with Acumatica v6.0 – 2022 R1, you will just need to unpublish/republish your existing Endpoints. See the Unpublish the V-Tech Endpoints procedure for more information.

Upload and Publish the Endpoints

Log in to your Acumatica Company. Select System > Customization > Manage > Customization Projects.
Select Import > Import New Project.
On the Open Package dialog, click in the File Path field and navigate to the ZIP file you downloaded based on your Acumatica version and click Open, then Upload.
You will see the “VTechEndPointv5” Project in the list. Check the check box for the VTechEndPointv5 and any other customizations that you want to use along with the VTechEndPointv5. If you have the V-Tech Custom Fields Customization, you should select that here.

Note
VTechEndPointv5 is for SOAP integration, while VTechEndPointv6 is for REST.
Click Publish.
In the Compilation window, click Publish.
After you see the message “Website has been updated”, you can click the “X” in the title bar to exit. The endpoints are published to the Customization Projects screen.

Configure the Endpoints

Select System > Integration > Configure > Web Service Endpoints.
In the Endpoint Name field, select the magnifying glass.
Select the VTECHAPI by double-clicking on it.
In the Endpoint Version field, click the magnifying glass and select the Endpoint
Version 5 for for SOAP integration and Version 6 for for REST by double-clicking it.
The VTECHAPI Endpoint Properties are displayed.

Copy the Acumatica Contract Service URL

Click the View Endpoint Service menu item and select WSDL for SOAP. For REST integration, click Assist Edit button and select OpenAPI 2.0 under the Service Definition.
A new tab launches. Copy the entire Contract API Link from the URL field at the top of the browser window. This is the URL that you will enter into the StarShip New Company dialog (or Edit Company if you are upgrading).

After copying the Acumatica Contract Service URL, you can continue to StarShip Setup.

Multiple Companies Setup

Acumatica users that would like to use multiple companies in StarShip should import and publish the V-TECH Endpoint into one company. Once the publishing is done, you can then import the Endpoint into your additional companies. It is not necessary to publish the Endpoint for each company. Once you import the published Endpoint into your other companies, the endpoint will appear as published.