Overview


The Komet Sales API helps you develop additional tools that are directly tied into the system. This will allow growers, customers or 3rd parties (such as other technology companies or your in-house developers) to expand and build on the Komet Sales platform. 


The API is an interface for accessing the Komet Sales data using HTTP and JSON. The API makes it easy to create web and desktop applications that integrate with the Komet Sales. Some potential uses include:

  • Creating a customized e-commerce solution that uses Komet Sales as the backend for order processing and inventory management.
  • Allowing the growers to integrate Komet Sales directly into their systems to review/confirm orders.
  • Integrating with your CRM system.
  • Interacting with other 3rd party systems that your company uses.

 

How to use the API

The Komet Sales API has a single point of entry:

https://api.kometsales.com/api/method.action

Please note that all requests must be submitted using SSL. You must send an authentication token per each request. Please use the login method to get your token and save it into your application. You will be able to use the same token from this point forward. You can also create tokens that are not linked to a user and access to a specific set of API methods can be limited.

Please note that the API is limited to 1,000 requests per user per day, based on the plan that the company has in Komet Sales. In other words, if the company is paying for 3 users in Komet Sales, your external system can only call the Komet Sales API 3,000 times (1,000 x 3) per day.

Tokens Generation

Tokens are an authentication mechanism that allows access to the API methods for the company. To set up a token, please follow these instructions:

  

Go to Setup > Settings and click on the "Tokens" link.

 If a new token needs to be created, click on the New Token green button located on the right-hand side of the window.

 Select which Token Type needs to be added: CompanyCustomer or Vendor.

 Input the information requested in order to complete the process:

  • Enter the token description, for example, "managing inventory".
  • Select the API method needed from the list available, in this case, "inventory.add".
  • Click on the Generate button and the system will create a token composed of numbers and letters. If the token was created for a Customer, the token must be sent to the customer.
  • Click on Save.

If the token needs to be edited, go to the "Actions" column, click on "Edit" and Save. 

Conventions
  • Items in bold are required.
  • Date and time values are of the form YYYY-MM-DD HH:MM:SS.
  • All time values are returned in UTC timezone. You can learn more about UTC here.
  • Booleans are either 1 (true) or 0 (false).
HTTP Status Codes

Some of the responses may contain HTTP status codes as the following:

CodeStatusDescription
200OKThe request succeeded.
201CreatedThe request has been fulfilled and the resource created.
204No contentThe request succeeded. However, the response does not have any content.
400Bad requestThe request was invalid.
401Not authorizedThe authentication token does not have enough privileges.
403ForbiddenThe server has rejected the request.
404Not foundThe resource requested does not exist on the server.
408TimeoutThe time allowed for the server to complete the request has been reached.
429Too many requestYou have exceeded the rate limit.
500Server ErrorMalfunctioning script, server configuration error or similar.
List of API Methods

 

 

 

  • No labels