An API is a software intermediary that allows two applications to talk to each other. In other words, an API is the messenger that delivers your request to the provider that you're requesting it from and then delivers the response back to you.
You can use W2P Cloud APIs to access orders, update shipping statuses or to log users in to a website using Single Sign On or Single Sign Up.
In order to use the APIs you will need to create a Key.
To create an API key, in the backend, go to Manage Sites then Producer Tools.
Then click on the link Web Service Keys for Producers
To add a new Key click on Add New Web Service Key at the top left.
Fill out the following fields:
Username: In most cases this would be a user who exists in the correct company that has Producer Access. This user links the API key to a valid user.
Company Name: For your own purposes, usually the company name that this application is for.
Application Name: For your own purposes, the application name you are using this API key for.
Company ID: If you are using Single Sign On then it would be the Company ID of the Site the user is logging into.
If you were downloading orders then it would be the company id of the Order, however, if you wanted to retrieve the data for every company you would put 0.
Prefix: This is for Single Sign Up. If you want the add a prefix to ALL users that are created that would ensure that usernames are unique for your company,
We have 2 sets of APIs. JSON APIs - youcan view the help file by going to InfoHandler API Help.
for XML API go to API Help.
Was this article helpful?
That’s Great!
Thank you for your feedback
Sorry! We couldn't be helpful
Thank you for your feedback
Feedback sent
We appreciate your effort and will try to fix the article