Enhanced Clicks API Manual
Enhanced Clicks API
A RESTful API to store and access enhanced click data.
Metadata:
You can access the metadata going to the next URL:
http://ec.katch.com:9044/metadata
Security and Information:
The API is available to the public, please be aware of the following:
If we undergo a DDoS attack the service will be shut down.
We store parameters as they come; we do not provide validations nor XSS verification.
Tokens generated will only return data, for a period of 24 hours, after that the data is lost.
PIIStoreRequest
REST endpoint used to store the data.
Verb: POST, GET
Route: /enhanced/pii
Headers:
User-Agent: <AgentName>
Host: ec.katch.com
Content-Type: application/x-www-form-urlencoded
POST + JSON
URL
http://ec.katch.com:9044/enhanced/pii
Request Body
{
"FName":"John",
"LName":"Doe",
"Email":"jdoe@katch.com",
"Address1":"2381 Rosecrans Ave.",
"Address2":"Suite 400",
"Phone":"(310) 906 5453",
"OwnVehicle":"Yes",
"State":"CA"
}
Request Response
"325749d166c941269cd9b3fef0deb47b"
GET + JSON
URL
http://ec.katch.com:9044/enhanced/pii?FName=John&LName=Doe&Email=jdoe@katch.
com&Address1=2381 Rosecrans Ave.&Address2=Suite 400&Phone=(310) 906
5453&OwnVehicle=Yes&State=CA
Request Body
{}
Request Response:
"325749d166c941269cd9b3fef0deb47b"
PIILookupRequest
REST endpoint used to retrieve the data.
Verb: GET
Route: /enhanced/pii/{Id}
NAME
Id
PARAMETER
path
DATA TYPE
Guid
REQUIRED
Yes
DESCRIPTION
Token returned on the store service.
Headers:
User-Agent: <AgentName>
Host: ec.katch.com
Content-Type: application/json
GET + JSON
URL
http://ec.katch.com:9044/enhanced/pii/{id}
Request Body
{"Id":" 325749d166c941269cd9b3fef0deb47b"}
Request Response
{"fname":"John","lname":"Doe","email":"jdoe@katch.com","address1":
"2481 Rosecrans Ave.","address2":"Suite 400","phone":"(310) 906
5453","ownvehicle":"Yes","state":"CA"}
© Copyright 2024