🔏
🔏
🔏
🔏
dStor Documentation
Search…
Using dStor
New to dStor? On this page, we'll show you everything you need to get started.
Intro
Integrating dStor into your application consists of a few simple steps.
- 1.Acquiring a dStor account
- 2.Creating an API key (optional)
- 3.Using your dStor account login credentials or using the API key to acquire a temporary access token
- 4.Attaching the temporary token to upload requests
The purpose of using the temporary access token model is to reduce reads to the dStor database, thereby ensuring that the system is able to remain performant even with a large number of users and dapps uploading content
Acquiring a dStor Account
To get started using dStor to store your files, navigate to https://app.dstor.cloud/request-dev-invite on your browser. Fill out your name, email, website, and tell us briefly about your storage needs.
Once you’ve filled everything out, "Submit" your request and look for an email from [email protected] to confirm. Once approved, you’ll receive an email with a link to register and create your password.
Enter these details once you receive your email invite
Now you’ll be able to login with your credentials and begin using dStor!
Uploading New Files
Now that you have logged in, you’ll arrive at the main dashboard where you can create a ‘New Folder’ or ‘Upload’ your files. From here you simply drag and drop files or folders, or select within the box to browse for files to upload. Folder structure maintenance is not currently supported, but will be in the future.
Organizing your data is important for many types of projects. To move items into folders, simply drag and drop into the appropriate folder, or click the menu button ⋮ and choose “[move files]”
Creating API Keys
In the dStor dashboard, click on the "Account" tab:
Now click the "Add" button to the top-right of the "Developer API Keys" table:
This will bring up a form where you will set a description of what the API key will be used for, and set a date when you would like the API key to expire. Then press the "Add" button:
The new API key, with its description and expiration, should now show up in your "Developer API Keys" table. In the "key" column you will see a truncated version of the API key. Click the copy icon next to the key in order to add the key to your clipboard for later use:
Acquire Temporary Access Token with API Key
To acquire a temporary token with an API key, send a
GET request to the following endpoint:
https://api.dstor.cloud/v1/dev/temp-tokenYou will need to add the following as headers:
1
"x-api-key": "your-dev-api-key" // required
2
"x-expiration": 1664349827 // optional, defaults to one year
Copied!
As a curl command it would look like the following:
1
curl --location --request GET 'http://api.dstor.cloud/v1/dev/temp-token' \
2
--header 'api-key: my-dev-api-key'
Copied!
The response should look like the following:
1
{
2
"access_token": "eyJhbsomebiglongstring9.eyJkIjpmYWxzZSwibyI6ZmFsc2UsInMiOmZhbHNlLCJ0IjpudWxsLCJpYXQiOjE2MzI3ODg4MzcsImV4cCI6MTYzMjc5MjQzNywiYXVkIjoiZHN0b3IuY2xvdWQiLCJpc3MiOiJkc3Rvci5jbG91ZCIsInN1YiI6ImIyZTI3ODE3LTA0MzktNDViZC04YTNkLTVjNTk2MTg1YmQwNSJ9.PyKa8sILa7nyD-4eI4lA0xjFBPcncNZQL4_iclZ_Fs8"
3
}
Copied!
This temporary access token is what you will attach to your uploads to get new content hosted on dStor.
Acquire a Temporary Access Token with Login Credentials
As an alternative to the API key form, you can request a temporary access token by using your normal dStor login credentials by sending a
POST request to the following endpoint:
https://api.dstor.cloud/v1/dev/temp-tokenThe body of the request should look like the following:
Copied!
If your login credentials are correct, you should receive a response that looks like the following:
1
{
2
"access_token": "eyJhbsomebiglongstring9.eyJkIjpmYWxzZSwibyI6ZmFsc2UsInMiOmZhbHNlLCJ0IjpudWxsLCJpYXQiOjE2MzI3ODg4MzcsImV4cCI6MTYzMjc5MjQzNywiYXVkIjoiZHN0b3IuY2xvdWQiLCJpc3MiOiJkc3Rvci5jbG91ZCIsInN1YiI6ImIyZTI3ODE3LTA0MzktNDViZC04YTNkLTVjNTk2MTg1YmQwNSJ9.PyKa8sILa7nyD-4eI4lA0xjFBPcncNZQL4_iclZ_Fs8"
3
}
Copied!
Again, this temporary access token will be attached to our upload requests in order to host new files to the dStor network
Uploading a File to dStor
Now that you have received your temporary access token, we will use it to upload a file to dStor. We will be sending a
POST request to the following endpoint:The following headers are optional. If you do not specify which folder to upload to, the API will upload it to your root folder:
1
"x-dstor-parent-id": number // ID of containing folder
2
"x-dstor-folder-path": string // path of containing folder
3
"x-dstor-comment": string // optional, useful for metadata purposes
Copied!
Please note that only the parent folder ID OR path is required, do not include both.
Additionally, you will need to set the Authorization as a bearer token with the temporary access token that you received in the previous section.
Naturally, your file should be uploaded as form data, so that your complete upload request should look something like the following:
curl
Javascript
NodeJS
1
curl --location --request POST 'https://api.dstor.cloud/api/v0/add' \
2
--header 'x-dstor-parent-id: 0' \
3
--header 'Authorization: Bearer eyJhbGciOiJSomeAccessTokenR5cCI6IkpXVCJ9.eyJkIjpmYWxzZSwibyI6ZmFsc2UsInMiOmZhbHNlLCJ0IjpudWxsLCJpYXQiOjE2MzI3OTI2NzUsImV4cCI6MTYzMjc5NjI3NSwiYXVkIjoiZHN0b3IuY2xvdWQiLCJpc3MiOiJkc3Rvci5jbG91ZCIsInN1YiI6ImIyZTI3ODE3LTA0MzktNDViZC04YTNkLTVjNTk2MTg1YmQwNSJ9.hVflWAvdw-jO2x_C_xvBcvAnXHusT8MpMZrzMs_7R_g' \
4
--form '[email protected]"/Users/SomeUser/Documents/hello-world.txt"'
Copied!
1
var myHeaders = new Headers();
2
myHeaders.append("x-dstor-parent-id", "0");
3
myHeaders.append("Authorization", "Bearer eyJhSomeAccessToken1NiIsInR5cCI6IkpXVCJ9.eyJkIjpmYWxzZSwibyI6ZmFsc2UsInMiOmZhbHNlLCJ0IjpudWxsLCJpYXQiOjE2MzI3OTI2NzUsImV4cCI6MTYzMjc5NjI3NSwiYXVkIjoiZHN0b3IuY2xvdWQiLCJpc3MiOiJkc3Rvci5jbG91ZCIsInN1YiI6ImIyZTI3ODE3LTA0MzktNDViZC04YTNkLTVjNTk2MTg1YmQwNSJ9.hVflWAvdw-jO2x_C_xvBcvAnXHusT8MpMZrzMs_7R_g");
4
5
var formdata = new FormData();
6
formdata.append("", fileInput.files[0], "hello-world.txt");
7
8
var requestOptions = {
9
method: 'POST',
10
headers: myHeaders,
11
body: formdata,
12
redirect: 'follow'
13
};
14
15
fetch("https://api.dstor.cloud/api/v0/add", requestOptions)
16
.then(response => response.text())
17
.then(result => console.log(result))
18
.catch(error => console.log('error', error));
Copied!
1
var https = require('follow-redirects').https;
2
var fs = require('fs');
3
4
var options = {
5
'method': 'POST',
6
'hostname': 'api.dstor.cloud',
7
'path': '/api/v0/add',
8
'headers': {
9
'x-dstor-parent-id': '0',
10
'Authorization': 'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkIjpmYWxzZSwibyI6ZmFsc2UsInMiOmZhbHNlLCJ0IjpudWxsLCJpYXQiOjE2MzI3OTI2NzUsImV4cCI6MTYzMjc5NjI3NSwiYXVkIjoiZHN0b3IuY2xvdWQiLCJpc3MiOiJkc3Rvci5jbG91ZCIsInN1YiI6ImIyZTI3ODE3LTA0MzktNDViZC04YTNkLTVjNTk2MTg1YmQwNSJ9.hVflWAvdw-jO2x_C_xvBcvAnXHusT8MpMZrzMs_7R_g'
11
},
12
'maxRedirects': 20
13
};
14
15
var req = https.request(options, function (res) {
16
var chunks = [];
17
18
res.on("data", function (chunk) {
19
chunks.push(chunk);
20
});
21
22
res.on("end", function (chunk) {
23
var body = Buffer.concat(chunks);
24
console.log(body.toString());
25
});
26
27
res.on("error", function (error) {
28
console.error(error);
29
});
30
});
31
32
var postData = "------WebKitFormBoundary7MA4YWxkTrZu0gW\r\nContent-Disposition: form-data; name=\"\"; filename=\"hello-world.txt\"\r\nContent-Type: \"{Insert_File_Content_Type}\"\r\n\r\n" + fs.readFileSync('/Users/kylan/Desktop/hello-world.txt') + "\r\n------WebKitFormBoundary7MA4YWxkTrZu0gW--";
33
34
req.setHeader('content-type', 'multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW');
35
36
req.write(postData);
37
38
req.end();
Copied!
The response object will look something like the following:
1
{
2
"Name": "hello-world.txt",
3
"Hash": "QmXEJJGbyMVa3jJ9iBATY8D1udATD7m6H7kVV7WoRgUEaT",
4
"Size": "25136"
5
}
Copied!
The
hash property, specifically, is what you will use in your app to access the file. If the upload was successful then you should see the file show up in your dashboard within a few seconds:
In order to access the file you will simply navigate to the following endpoint, with the has attached to the end:
Congratulations, you have uploaded your content to dStor!
View and Pay Your Bill
dStor customers are invoiced at the end of each month for services rendered over the previous month. You will receive an invoice to the email address associated with your dStor account. Additionally, you will be able to view and pay your invoices directly from the dashboard under the ‘Account’ tab.
dStor uses Stripe for payment processing of cards and ACH transactions. Select ‘Pay Now’ to choose your method of payment, and complete the transaction.
Alternatively, you may pay your invoice with TLOS to the [pay.dstor] Telos address. TLOS balance conversions are created from TLOS/USD value at date and time of billing.
Secure on dStor
dStor customers may download and use the ‘Secure on dStor’ tag to show off that their files are tamper-proof, DDoS resilient, and decentralized on dStor! Click the link below to download the file.
Secure_on_dStor_Logo_525x285.png
23KB
Image
Secure on dStor
Last modified 8mo ago