|
POSitive API |
  
|
|
POSitive API |
|
Note: The POSitive Anywhere web service must be running on your server in order to use the API. You'll need to have an active Gold Subscription in order to use POSitive Anywhere, and it may be necessary to update your POSitive registration key. Contact POSitive for more information. Click here for POSitive Anywhere setup instructions.
POSitive Software Company has decided to no longer create, and maintain, individual interfaces to specific services such as e-commerce sites, and has released an API that will allow developers to create custom interfaces for a variety of services.
API is the acronym for "Application Programming Interface", which is a software intermediary that allows two applications to talk to each other. Each time you use an app like Facebook, send an instant message, or check the weather on your phone, you’re using an API.
Think of an API like a menu in a restaurant. The menu provides a list of dishes you can order, along with a description of each dish. When you specify what menu items you want, the restaurant’s kitchen does the work and provides you with some finished dishes. You don’t know exactly how the restaurant prepares that food, and you don’t really need to.
Similarly, an API lists a bunch of operations that developers can use, along with a description of what they do. The developer doesn’t necessarily need to know how, for example, an operating system builds and presents a “Save As” dialog box. They just need to know that it’s available for use in their app.
This isn’t a perfect metaphor, as developers may have to provide their own data to the API to get the results, so perhaps it’s more like a fancy restaurant where you can provide some of your own ingredients the kitchen will work with.
But it’s broadly accurate. APIs allow developers to save time by taking advantage of a platform’s implementation to do the nitty-gritty work. This helps reduce the amount of code developers need to create, and helps create more consistency across apps for the same platform. APIs can control access to hardware and software resources.
Documentation for the POSitive API is available here: POSitive API Documentation
(See: Additional Settings for E-Commerce)
Creating your API Credentials
In your POSitive product go to E-Commerce, Web Store Setup, Developer Integration. Click the Add button and enter the following:
1. Create a name to identify what these credentials are for. In our example it is for the API.
2. Create a Developer ID. This can be anything you want and may contain a mix of letters, numbers and special characters.
3. Create a Developer Key. Again, this can be anything you want and may contain a mix of letters, numbers and special characters.
Click OK to save your credentials, which you will also use in your interface to connect to POSitive's database.