Quickstart

Learn how to add a file and verify its authenticity under 10 minutes.

🚧

Requirements

You need your API key to perform the actions on this page.
You also need the Keeper Admin Role.

If you don't have an API key, please refer to this section to get your API key.

There are three steps for this section:

  1. Create a folder
  2. Add a file
  3. Compare the file with another file

Download the following files:
Original file: https://support.oneskyapp.com/hc/en-us/article_attachments/202761627/example_1.json
File to compare: https://support.oneskyapp.com/hc/en-us/article_attachments/202761727/example_2.json

With these files, we can now store the original file and use the file to compare with the stored file.


Create a folder

Replace the following parameters:

{{YOUR_API_KEY}}: Your own API key
{{FOLDER_NAME}}: The name of the folder you are about to create, choose whatever you want

curl -X POST \
  http://api.mantle.services/keeper/folders \
  -H 'Accept: text/plain, application/json, text/json' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {{API_KEY}}' \
  -d '{ "name": "{{FOLDER_NAME}}" }'

You should have this as a response:

{
  "id": "{{FOLDER_ID}}",
  "name": "{{FOLDER_NAME}}",
  "fileQuantity": 0,
   ...
}

Keep the {{FOLDER_ID}} value, we will use it in the next step.

Add a file

Replace the following parameters:

{{YOUR_API_KEY}}: Your own API key
{{FOLDER_ID}}: The ID of the folder we got from the step before
{{FILE_TO_ADD}}: The original file you've downloaded before
{{DISPLAY_NAME}}: The name of the file you are about to add, choose whatever you want

curl -X POST \
  http://api.mantle.services/keeper/files \
  -H 'Accept: text/plain, application/json, text/json' \
  -H 'Content-Type: multipart/form-data' \
  -H 'x-api-key: {{API_KEY}}' \
  -F 'folderId={{FOLDER_ID}}' \
  -F 'accuracy="Medium"' \
  -F 'file={{FILE_TO_ADD}}' \
  -F 'displayName={{DISPLAY_NAME}}'

You should have this as a response:

{
  "id": "{{FILE_ID}}",
  "accuracy": "Medium",
  "keeperType": "Text",
  ...
}

Keep the {{FILE_ID}} value, we will use it in the next step.

Compare the file with another file

Replace the following parameters:

{{FILE_ID}}: The ID of the file we got from the step before
{{API_KEY}}: Your API key
{{FILE_TO_COMPARE}}: The file to compare you've downloaded previously

👍

Congratulations!

You've added a file's fingerprint in the blockchain and checked its authenticity with Keeper!