Help

The JOOR Advanced Integration Suite (AIS) makes use of common conventions for HTTP requests and responses. This section provides high-level overview of how those conventions are applied to the API Web Service API’s as well as pointers and examples of common usage of the APIs.

HTTP Headers

Request/Response Headers are used to control authentication, the type of call being made (insert, update or delete) as well as the format of data being sent or requested. Failure to properly construct your headers for requests may result in errors or unexpected results.

HTTP Request Methods

The JOOR API requires the appropriate Request Method to be sent with all API calls. The request method will determine the action taken to the data. In most cases, a single endpoint may be called with several request methods (see documentation for supported request methods). Supported request methods are as follows:

  • POST – used to insert data on the JOOR Platflorm
  • PUT – used to update existing data on the JOOR Platform (either from previous POSTs or manual entry)
  • GET – used to retrieve or export data from the JOOR Platform
  • DELETE – used to deactivate or otherwise remove data from the JOOR Platform

Content-type

You must supply the content type of your requests in the HTTP header in order to receive a response. Accepted content types are as follows:

  • image/jpeg
  • application/xml
  • application/json

Your application may send requests in one content type and request that the response be sent in an alternate content type (as long as the content type is supported for the call being made). This extremely rare case may be useful for translating data between several third party or legacy systems.

Token Access

Tokens are generated by the JOOR technical team and provided to approved clients to access the AIS web services. Tokens that are lost, exposed or otherwise abused can be deactivated to prevent access or leakage of data. Tokens must be passed using the OAuth2 Authorization Header. The token should be Base64 encoded when sent in the Authorization Header.

Format: "Authorization" ":" token

Example:
Authorization: Oauth2 QWxhZGRpbjpvcGVuIHNlc2FtZQ==

🚧

Token Expiration

After 90 days of no activity, tokens will expire. If this occurs, the JOOR account manager can reactivate the token.

Price Types

The JOOR platform allows clients to not only sell their products in multiple currencies but also allows multiple price levels per currency. Most clients may not require this level of matrix for style pricing, but for clients who do, this provides a powerful way to segment pricing to match geographic or transportation cost fluctuations.

By default, accounts are provided with a standard US Dollar Price Type (USD). Clients may add as many price types as required to meet their needs. Each price type consists of a currency (sent as 3 digit ISO standard currency codes) and a label. Labels are useful when an account has several price tiers within one currency to help distinguish on the front-end applications.

A common example is need for a domestic versus international style price within one currency. As such, it is recommended that the second price type contain a label “international”. This will make customer pricing assignment, report filtering and order price assignment easier to manage by end users.

Certificates

🚧

SSL handshake error

If you experience an SSL handshake error when connecting to JOOR's API, this might be due to your network or client not trusting Amazon’s root certificate.

In January, 2018 AWS started issuing certificates based on their own root certificate. JOOR’s certificate is part of this new Amazon certificate chain. If you cannot make the SSL handshake, your network or client administrator might need to add this certificate to your trusted store:
https://aws.amazon.com/blogs/security/how-to-prepare-for-aws-move-to-its-own-certificate-authority/

If you do not want to add Amazon as a new trusted root certificate, JOOR's Integrations Team can send you JOOR’s specific certificate to trust on a per-request basis. However, we recommend trusting the Amazon root certificate so you don’t need to take further action.


Did this page help you?