conttact.us

1. Create User

Method	URL	Format
POST	http://conttact.us/api/user/	JSON

First name

Required:	Yes
Type:	String
Description:	New user's first name
Sample JSON: "first_name" : "John"

Last name

Required:	Yes
Type:	String
Description:	New user's last name
Sample JSON: "last_name" : "Smith"

Email

Required:	Yes
Type:	String
Description:	New user's valid email address
Sample JSON: "email" : "john.smith@mail.com"
Errors:	Error: 012 - This user already exists

Password

Required:	Yes
Type:	String
Description:	A robust password for new user account
Sample JSON: "password" : "abcd!234"

2. Update User

Method	URL	Format
PUT	http://conttact.us/api/user/{user ID}	JSON

Refer to "Create User" parameters to edit the user's account details and replace the values with the new content.

3. Delete User

Method	URL	Format
DELETE	http://conttact.us/api/user/{user ID}	JSON

1. Create Card

Method	URL	Format
POST	http://conttact.us/api/card/	JSON

Email, Version

Required:	Yes
Type:	String Value: String Description: - Sample JSON: "email" : "john.smith@mail.com", "version": "1.0"
Errors:	Error: 008 - Invalid credentials Error: 009 - JSON template version mismatched

Title

Required:	Yes
Type:	String Value: String Description: The title of the Conttact Card Sample JSON: "title": "Greenworks Pvt. Ltd."
Errors:	Error: 001 - Title cannot be empty

Logo

Required:

Type:

String
- Value: URL
- Description: URL pointing to an logo image for the card
- Sample JSON: "logo": "https://wiki.videolan.org/images/Ubuntu-logo.png"
Object
- Value:
  - URL: URL pointing to an image(logo) for the card
  - type: a setting of how you want the images in your gallery displayed. Available options:
  
  "sb" - display logo and title
  
  "text" - display title only
  
  "logo" - display logo only
- Description: Object to define more parameters
- Sample JSON:
```
 "logo": {
	 "url" :"https://wiki.videolan.org/images/Ubuntu-logo.png", 
	 "type": "logo"
 }
```

Errors:

Error: 001 - URL field cannot be empty
Error: 002 - Invalid image URL
Error: 003 - Invalid URL format

Description

Required:	No
Type:	String Value: String Description: Description of the guard Sample JSON: "description" : "Greenworks established in 1965 is a retail company that sells environment-friendly office furniture."

Background

Required:

Type:

String
- Value: URL
- Description: URL pointing to a background image for the card
- Sample JSON:
```
 "background": "https://wiki.videolan.org/images/Ubuntu-logo.png"
```

Object

Value:
- URL: pointing to a background image for the card
- theme_id: the selected theme ID from the system's list of provided themes. Available options:

"theme-0"	-	Renege: A vibrant, modern theme that pops out the important details fit for your social-oriented business
"theme-1"	-	Professional: Sleek and translucent dichromatic theme that's suited to reflect your formal corporation

- custom_classes: custom css that can be applied to the card

Description: Object to define more parameters

Sample JSON:

"background": {
	"url" :"https://wiki.videolan.org/images/Ubuntu-logo.png", 
	"theme_id": "theme-1", 
	"custom_class": "theme-base-style" 
}

Errors:

Error: 001 - Image URL cannot be empty
Error: 002 - Invalid image URL
Error: 003 - Invalid URL format

Keywords

Required:	No
Type:	String Value: String Description: A descriptive keyword to apply to the card for Search Engine Optimization Sample JSON: "keywords":"contact" Array Value: An array of strings Description: An array of descriptive keywords to apply to the card for Search Engine Optimization Sample JSON: "keywords": [ "contact", "mobile", "call", "phone" ]

Language

Required:

Type:

Object
- Value:
  - code: iso639-2 standard code for the language of the content of the Conttact Card. Available options:
  
  "en" - English
  
  "ms" - Melayu
  
  "zh" - Chinese
  
  "ja" - Japanese
  
  "ar" - Arabic
  
  "fr" - French
  
  - direction: the direction of the language of the content of the Conttact Card. Available options:
  
  "ltr" - Left to right
  
  "rtl" - Right to left
- Description: Object to define language content of the Conttact Card.
- Sample JSON:
```
"language":{
	"code":"en",
	"direction":"lrt"
}
```

Widgets

Required:	Yes
Type:	Array Value: An array of widget objects listed and described hereafter. Description: The widgets used for the Conttact Card. Sample JSON: "widgets": []
Errors:	Error: 001 - Widgets cannot be empty

Widget-Title

Required:	No
Type:	Object Value: - type: "small-title" - content: A string content of the title widget Description: Short text, eg. company tagline. Sample JSON: { "type":"small-title", "content":"Environmental friendly office furniture" }
Errors:	Error: 001 - Title cannot be empty

Widget-Paragraph

Required:	No
Type:	Object Value: - type: "para-text" - title: A string heading - content: A string content of the paragraph widget Description: Long text, eg. company description. Sample JSON: { "type":"para-text", "title":"About us", "content":"Greenworks established in 1965 is a retail company that sells environmental friendly office furniture. We only use the industry's finest raw materials." }
Errors:	Error: 001 - Paragraph cannot be empty

Widget-Phone

Required:	No
Type:	Object Value: - type: "phone" - title: A string heading - content: A string phone number Description: A phone number. Sample JSON: { "type":"phone", "title":"Drop us a call", "content":"012-5555555" }
Errors:	Error: 001 - Phone number cannot be empty

Widget-Email

Required:	No
Type:	Object Value: - type: "email" - title: A string heading - content: A string email address Description: An email address. Sample JSON: { "type":"email", "title":"Drop us a call", "content":"john.smith@mail.com" }
Errors:	Error: 001 - Email cannot be empty Error: 004 - Invalid Email format

Widget-Web

Required:	No
Type:	Object Value: - type: "web" - title: A string heading - content: A string url. Description: A valid url. Sample JSON: { "type":"web", "title":"Company Website", "content":"http://www.example.com" }
Errors:	Error: 001 - Web URL cannot be empty Error: 005 - Invalid web url format

Widget-badge-grid

Required:

Type:

Object

Value:
- type: "badge-grid"
- title: A string heading
- layout: A string to define the layout of the image gallery. Available options:

"grid"	-	displays all the images in a row (equally-spaced out)
"fixed-grid"	-	displays all the images and their captions in a row (pulled to the left)
"list"	-	displays all the images and their captions in a stack

- content: An array of image objects. The image object properties are:
        - title: A string caption for this image
        - url: A string url that points to this image
        - link: A string url that will leads to another website when audience clicks on this image.

Description: A gallery to display mutliple images.

Sample JSON:

{
 "type":"badge-grid", 
 "title":"Company awards", 
 "layout":"list", 
 "content":[
 	{
 		"title":"MSC Status",
 		"url":"http://cdn.greenworks.com/images/MSC-logo.png",
 		"link":"http://www.mdec.my"
 	},
 	{
 		"title":"SME 100 Fast Moving Companies",
 		"url":"http://cdn.greenworks.com/images/sme100-logo.png",
 		"link":"http://sme100.asia"
 	}
   ]
}

Errors:

Error: 001 - Title value cannot be empty
Error: 002 - Invalid image URL
Error: 003 - Invalid URL format
Error: 006 - The gallery widget holds up to four images only

Widget-socialize

Required:	No
Type:	Object Value: - type: "widget-socialize" - title: A string heading - content: An array of social network. The social network object properties are: - type: A string heading for this social network - link: A string url that points to this social network Description: A list of social network links for your audience to connect with you. Sample JSON: { "type":"widget-socialize", "title":"Social Contact", "content":[ { "type":"facebook", "link":"http://facebook.com/greenworks" }, { "type":"twitter", "link":"http://twitter.com/greenworks" }, { "type":"googleplus", "link":"http://googleplus.com/greenworks" }, { "type":"linkedin", "link":"http://linkedin.com/greenworks" } ] }
Errors:	Error: 001 - Link cannot be empty Error: 003 - Invalid URL format

Widget-address

Required:	No
Type:	Object Value: - type: "address" - title: A string heading - address1: A string first line of an address - address2: A string second line of an address - city: A string city - state: A string state - country: A string country - zipcode: A string zipcode - latitude: A string latitude - longitude: A string longitude Description: A geographical location. Sample JSON: { "type":"address", "title":"Company headquarters", "address1":"#7 Neptune Street", "address2":"Seven hills park", "city":"Kuala Lumpur", "state":"Kuala Lumpur", "country":"Malaysia", "zipcode":"12500", "latitude":"3.1577", "longtitude":"2.0014" }
Errors:	Error: 001 - Title value cannot be empty Error: 001 - Address1 value cannot be empty Error: 001 - City value cannot be empty Error: 001 - State value cannot be empty Error: 001 - Country value cannot be empty Error: 001 - Latitude value cannot be empty Error: 001 - Longtitude value cannot be empty

2. Update Card

Method	URL	Format
PUT	http://conttact.us/api/card/{card ID}	JSON

Refer to "Create Card" parameters to edit the card and replace the values with the new content.

3. Delete Card

Method	URL	Format
DELETE	http://conttact.us/api/card/{card ID}	JSON

API Overview

Get a Reseller ID

1. Create User

Method

URL

Format

First name

Last name

Email

Password

2. Update User

Method

URL

Format

3. Delete User

Method

URL

Format

1. Create Card

Method

URL

Format

Email, Version

Title

Logo

Description

Background

Keywords

Language

Widgets

Widget-Title

Widget-Paragraph

Widget-Phone

Widget-Email

Widget-Web

Widget-badge-grid

Widget-socialize

Widget-address

2. Update Card

Method

URL

Format

3. Delete Card

Method

URL

Format