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
...
| Note |
|---|
DEPRECATION NOTICE: The old URI |
| Warning |
|---|
Consult support@onlinephotosubmission.com before using this endpoint. This is designed to be used by clients sparingly, for example, one log statement per workstation or service account per hour. |
that help identify all API activity with your client application(s). This helps us troubleshoot integration problems when they arise.
| Note |
|---|
|
Logging via Optional URL Parameters:
You 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
| Code Block |
|---|
{
"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
| Code Block |
|---|
204 NO CONTENT |