Superfy Platform API Documentation


Get Company Information API

Require Authentication

This API is used to Get Company Information based on combination of deviceID and token.


URL

api/companies/information

Required parameter (POST)

Optional parameter

Example JSON Payload

{
	"deviceID": "ABCD-EFGH-IJKL-MNOP",
	"token": "bb602ab13b8090268cd6e3bb9dfa39e2"
}

Possible return HTTP status code

Return message

{
  "status": "success",
  "message": {
    "company": {
      "companyID": 16,
      "companyName": "Smartsensor Live Testing",
      "companyLogoURL": "https://wasteinsights-files.s3.ap-southeast-2.amazonaws.com/uploads/companylogo/16/f9d89f802cd5479c958e17944b5c2d4d.jpg?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=1234567890AbcDeFghIj%2F20230817%2Fap-southeast-2%2Fs3%2Faws4_request&X-Amz-Date=20230817T075931Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Signature=123456789009876543214c286c6e40b37a46e04525cb28368990e206d741f216",
      "companyAddress1": "Tanah Abang",
      "companyAddress2": "",
      "companyCity": "Jakarta",
      "companyState": "Jakarta Pusat",
      "companyCountry": "Indonesia",
      "companyZipCode": "4011",
      "companyLatitude": -6.20397233963,
      "companyLongitude": 106.80513763428,
      "companyPhone": "1234567890",
      "companyFax": "1234567890",
      "companyWebsite": "http://www.google.com",
      "expiredDate": 0,
      "default_currencyCode": "AUD",
      "default_paymentPeriod": "monthly",
      "fillLevelSource": "laseravg",
      "collectionCalculationConfig": "standard",
      "bulkCollectionRadius": "2000",
      "licenseTypeID": 1,
      "licenseTypeName": "Town Plan"
    },
    "account_information": {
      "total_user": 3,
      "user_limit": 1,
      "total_projects": 10,
      "project_limit": 1,
      "total_pins": 80,
      "pin_limit": 100
    },
    "oldsensor": false
  }
}

Note:
"user_limit" contains number of allowed users in the same company. If its value is -1, it means that it is unlimited.
"project_limit" contains number of allowed projects in the same company. If its value is -1, it means that it is unlimited.
"pin_limit" contains number of allowed pins/bins/assets in all projects in the same company. If its value is -1, it means that it is unlimited.