0%

API Overview

Required parameters



Before you start, you will need to have an API account created, please reach out to us via the following link for additional information. https://www.3clickscloud.com/en_AU/contact

At a minimum, the 3 Clicks Cloud API requires the following four parameters.

Name

Description

api_key

API Key

data

main request data, json format

signature

generated signature based on api key/secret, time, data

timestamp

current unix timestamp

Request Types

The 3 Clicks Cloud API supports CRUD for the Order and Style applications.

  • GET, parameters on URL

    http://892.892clicks.local/api_user/order/details?api_key=eda980d8-0bda-42c9-bdea-f69d3e19197e&data=%7B%22order_number%22%3A%22PO07670%22%7D&signature=224de1af4b4c164d60ec1078ecb69e78d98c86a0&timestamp=1552553560

  • URL - put/post/delete

    • The URL must match the format below

      http://892.892clicks.local/api_user/order/details?api_key="KEY"&signature="SIGNATURE"&timestamp="TIMESTAMP"

  • Body - put/post/delete

    • The content must be in the request body, json format

      "data":{"order_number":"XYZ123"}

  • Request

    • method must be lowercase: put, post, delete

      (api_method, api_endpoint, data)

Signature Calculation

The appropriate signature must be calculated prior to calling the API. We have created a tool to assist with the testing.

Source Data

Part

Description

[1]

API Key

[2]

API Secret

[3]

HTTP Method, GET/POST/PUT/DELETE

[4]

DATA, main data of user request, packed in json format

[5]

Current unix timestamp, must be the same with the timestamp on '1. four required parameters on each request

Calculation

  • signature= sha1([Part1][Part2][Part3][Part4][Part5])

API Request Example

Provided is an example of the expected API output based on the first API call.

0%