Trace API Guide

Tips for API Usage

Here's a brief guide on how to use the event records API.
Reference) Structure of Event Records
This is an example of applying [Trace] to a service that records documents.
The event tracking target ID (Object Identifier) is the target ID to be tracked in the project and can be used as an index. You can also use the same ID repeatedly in multiple events. Thus, you need to set it to a distinguishable value, and you can group events by that ID. EX) "Contract document_200101", "Expensive resolution_Mr. Kim_200101"
Event name is the name of the event to be recorded and the event name that occurred in the "event tracking target ID" mentioned earlier. The ID and event will be grouped 1: N. For example, you can include all events raised by the event tracking target ID, such as "CreateDocument", "EditDocument", "DeleteDocument", etc.
User information (User Identifier) is information about the user who caused the event. For example, any form of ID that can be identified, such as the employee number "3873984" or the name "John."
Time Stamp is a time stamp of the time the event occurred, and you can write it in "Unix Time Stamp" format. For example, you can set it to "1607662234".
Data allows you to write what you want to record about the event. Any data can be recorded in the Json format, such as the body of the document, the first author, author IP, and the number of revisions to the document. 30kb is 30,000 characters based on numeric input. The number of characters that can be entered may vary depending on the type of character input, so please check the website below:
If you do not want to directly record plaintext data, or if you want to record a large-sized document body more safely and efficiently, we recommend that you Hash the data/document and record it.
โ— Hash๋ž€?
A hash function is a function that maps data of arbitrary length to data of fixed length. A cryptographic hash function can be used in cryptography as the hashing values created by mapping alone make it difficult to determine the original input value.
Among the SHA256 or KECCAK256 hash methods, we recommend the KECCAK256 method.
Keccak-256 is one of the Keccak algorithm groups, and it is a cryptographic hash algorithm developed to improve the security vulnerabilities inherent in hash functions SHA-1 and SHA-2 in use, which have been approved by the US NIST.
API calls are limited to 30 KB or less in all fields.

How to Create and Prepare to Use API

To link Trace API, you need to create an API key in the Luniverse Service and grant the Trace Management permission. Check the link below for details. ๐Ÿ‘‡

API Guide

Trace API is an API used to link functions such as event recording, inquiry, and verification. Link the records of the services you are using with the API

๐Ÿ‘‰Go to API Guide โ€‹

Copy link
On this page
Tips for API Usage
How to Create and Prepare to Use API
API Guide