Client Registration

Client Identifier

Choose a client identifier based on you domain name and client purpose, i.e. client=us.cloudcard.sampleClientApp or client=com.mycompany.downloader

The client identifier should then be included as a URL parameter to all subsequent API requests. This will allow us to quickly filter all your requests together to aid in troubleshooting integration problems.

URI: `https://api.cloudcard.us/log`

HTTP Method: POST

Required Headers: X-Auth-Token for a service account (see: Authentication)

Purpose: The purpose of this endpoint is to enable clients to post log entries into the server log that help identify all API activity with your client application(s). This helps us troubleshoot integration problems when they arise.

All client integrations should log to this endpoint at least once per 7 days but no more often than once per hour.
the client identifier should be included as either a URL parameter or in the JSON request body.
the client identifier should be included as a URL parameter on all subsequent requests from the client application

Logging via Optional URL Parameters:

In addition to the client identifier, you may include any other URL parameters you wish to have logged, e.g. /log?client=ABC&version=1.2.3
The result of passing these parameters would be that the following would be output in the log file:
{username} from {org name} logged: [client:ABC, version:1.2.3]

Logging via Optional JSON Body

In addition to the client identifier, you may include any other JSON fields you wish to have logged.

Example HTTP Request Body - optional

{
	"client": "XYZ",
	"version": "1.2.3.4",
	"instance": "workstation 3",
	"ip-address": "123.45.67.89"
}

The result of posting this JSON body would be that the following would be output in the log file:
{username} from {org name} logged: [ip-address:123.45.67.89, client:CPC, instance:workstation 3, version:1.2.3.4]

Response

204 NO CONTENT