Quick Start

Last updated: February 19th, 2020

Auth Token

POST

/authentication

Auth - Create new Token

Used to create new token used to authenticate future actions

Input Parameter
Field Type Description
client_id String Authentication Client Id
client_secret String Authentication Client Secret
Example Usage

curl -d "client_id=12345678&client_secret=acbd123456789efghijklmnop12345678" \
-H "Content-Type: application/x-www-form-urlencoded" \
-X POST  https://apiuat.doccollecthub.com/api/authentication
Success 200
Field Type Description
access_token String New Token
token_type String Token Type
expires_in String Token expires in seconds
Example Response

{
    "access_token": {token},
    "token_type": "Bearer",
    "expires_in": "900"
}
Error 4xx
Field Type Description
noAccessRight String Only valid API credentials can recieve tokens.

Customers

POST

/customer

Customer - Create new Customer

Used to create new customer in Doc Collect Hub

Input Parameter
Field Type Description
data Object Data Object Array
    brandID String (required) Unique Brand ID
    idNumber String (required) Unique Customer ID Number
    title String Title of the customer
    firstName String First name of the customer
    surname String (required) Surname of the Customer
    cellNum String (required) Cellphone Number of the Customer
    workNum String Work Number of the Customer
    homeNum String Home Number of the Customer
    email String Email Address of the Customer
    language String Language Identifier for the Customer
    extUniqueId String Unique identifier from external system
    custString1 String Custom String 1
    custString2 String Custom String 2
    custString3 String Custom String 3
    custString4 String Custom String 4
    custString5 String Custom String 5
Example Usage

curl -d '{
		"data": [{
			"brandID":"5", 
			"idNumber":"1234567890",
			"title":"Mr", 
			"firstName":"Joe", 
			"surname":"Black", 
			"cellNum":"5553126421", 
			"workNum":"5553126421", 
			"homeNum":"5553126421", 
			"email":"joe@black.com",
			"language":"E",
			"extUniqueId":"ext51726",
			"custString1":"Hello",
			"custString2":"Joe",
			"custString3":"Black",
			"custString4":"Custom",
			"custString5":"String"
			},{
			"brandID":"5", 
			"idNumber":"1234567890",
			"title":"Mrs", 
			"firstName":"Joe", 
			"surname":"Black", 
			"cellNum":"5551323421", 
			"workNum":"5551323421", 
			"homeNum":"5551323421", 
			"email":"mrs.joe@black.com", 
			"language":"E",
			"extUniqueId":"ext51727",
			"custString1":"Hello",
			"custString2":"Joe",
			"custString3":"Black",
			"custString4":"Custom",
			"custString5":"String"
			}]
		}' \
-H "Content-Type: application/json" \
-H "Authorization: Bearer {token}" \
-X POST  https://apiuat.doccollecthub.com/api/customer
Success 200
Field Type Description
status String Status of insert
data Object Data Object Array
    success String Number of successful records
    error String Number of error records
    total String Total Number of records received
Error 4xx
Field Type Description
noAccessRight String Only authenticated tokens can insert data.
error String Issue with the data passed.