Skip to main content

Publish Data

Publishing your own data is incredibly exciting and we’re here to walk you through the process. First you need to determine if you’d like to publish a single file of data (free or monetized at a one time fee for purchasers) or if you prefer to publish a subscription (in which purchasers would subscribe to recurring payments which you can customize).

Publishing a single dataset file

  1. Navigate to the Publish page from the menu at the top of the screen
  2. Click on the “Select to publish a single dataset file” button
  3. Fill out the data form, mandatory fields are: Title, Description, and Provider. Adding more information that better describes the data will help its discoverability.
  4. Click Next at the top right above the menu and choose your file to add to the uploader (or add your file URL if you know it)
  5. Once your file is uploaded, click Next again to confirm your upload on the confirmation page. If everything looks good to you, click the “Publish Data” button
  6. Congratulations, you’ve just published your own data to the dClimate Marketplace!

Publishing a subscription

  1. Navigate to the Publish page from the menu at the top of the screen
  2. Click on the “Select to publish a subscription” button
  3. You will need a Collection to publish a subscription. If you do not have one, select the “Create a new collection” button and follow the steps. If you have a collection already, select it from the dropdown menu
  4. Fill out the data form, mandatory fields are: Title, Description, and Provider. Adding more information that better describes the data will help its discoverability.
  5. Click Next at the top right above the menu and set up your API model
  6. Review your subscription overview on the next page and if everything looks good click next to confirm on the confirmation page. If everything looks good to you, click the “Publish Data” button
  7. Congratulations, you’ve just published a subscription to the dClimate Marketplace!

Subscriptions are a new way for companies to sell pay-gated access to their apis through a subscription model. This new feature makes is easy to quickly connect and sell existing data without any or only minimal changes on the API side.

Let’s Get Started to see how it works!

Step 1:

First step is to connect to dClimate with whatever wallet method you prefer.

Step 2:

Navigate to the collections page found in the profile section.

image

Now we can create our own collection by clicking “Create New Collection”

Step 3:

Fill out the details with the name, description and URL. This can be edited later so do not stress about the perfect details. The name in this case would relate to what people can access when subscribing to the collection. Examples could be “dClimate’s Tidal Patterns” or “dClimate Global Precipitation” or if you plan on only having one collection, it could simply be, “dClimate’s Collection”. The description should briefly describe what access the potential subscriber will receive and the URL should be a link for more info. In this case it could be “https://dclimate.net/tidalPatterns” if we were to describe a subscription for tidal patterns or it could just be “https://dclimate.net” for a broad overview.

Step 4:

Now that the subscription is in place, we need to start adding tiers. Tiers let you control the level of access to your api. Although we don’t currently limit the number of tiers, we recommend no more than three for ease of use for potential subscribers.

image Above you can see you can see multiple options. The name should describe the tier level roughly in relation to price. In this case we will make the lowest tier and call it Bronze. We also have three different prices based on the duration purchased. Any subscription purchased for a time between 1 and 6 months will cost 30$ per month upfront. Anything between 6 months and 12 months will cost 20$ per month up front and anything longer than 12 months will cost 15$ per month up front.

Important: The prices can be changed after the tier is created but the name CANNOT. Please ensure you are using a right name you wish to use.

Now that the tier is created, we can add another and call it “Premium” with higher prices.

Step 5:

Now we can publish our first subscription! Lets go to the publish page and select “Publish a Subscription”,

image then select you already have a collection, image and then select the collection from the dropdown. image

Now we can start to fill out our information that accurately describes the data you wish to sell. It is important to fill this out accurately so users can easily search and find your subscription.

image

Make sure to select “API Provider” from the provider dropdown.

image

After you have filled out the details you can select “next”.

Step 6:

This next step involves describing your API and how to connect for each tier.

We will use dClimate Japan station history api as an example.

Below we give the base url on which we will attach parameters and routes. We gives the access key (WHICH WILL BE ENCRYPTED) and indicate the key identifier should be placed in the header. It will help to give potential customers an idea of how the data will look so you can upload a small sample data for them to play around with. They can download this sample data without purchasing a subscription.

image

Now we can build the API with our API builder. Since we have two tiers, we can build it for premium and bronze. There are options to upload a saved config or save the config. This allows you to save your work and come back to it.

The preview button lets you see how it will look to end users when they make a request to your API from dClimate.

image

Let’s first give a name called “Station Name”. From this we can indicate the possible routes and options available.

We select the “Add More” to further define our API. As you can see, we can add a route to this name as well as given two options. Options are comma delimited.

image

By Clicking add you can see the routes are added. If we click on the preview, you can see the dropdown show up with the title “Station Name” and the two options found in routes. When we click on “Tokyo” a preview URL is generated above. This is what dClimate will call when a user makes this selection. Since premium is selected, only this will show to premium tier subscribers

image

Let’s add another level to further define the API.

image

image

image

Above you can see another level is defined and we can select between TAVG and MAVG which is then displayed in the preview url.

Now lets add a parameter to our API. Here we add Units and attach it to our TAVG,MAVG routes. In the preview we can see how its defined and how the request will be generated.

image image

That’s it! we have now defined our API for the premium tier level. Lets define it for the bronze tier.

We save the config, and then select the bronze option. Now you can see its empty. Lets upload the config we just saved to replicate our work on the premium tier. You can now see its identical.

image

Now for the bronze tier, lets only allow “Sapporo, Fukuoka”. We can edit it directly.

image image

Now only those two cities Sapporo and Fukuoka are allowed in the bronze tiers. Since a Premium tier should allow more than a bronze tier. We can edit the premium tier to allow 4 cities while only allowing the bronze tier to access two cities.

Once you are happy and have thoroughly tested your API with the preview. You can select next. This will generate a quick overview of everything. If you are happy with that, you can select next and publish your API! Note: We do not yet support Editing Collections but will do so in the not too distant future, please ensure you reviewed your API accordingly (API Preview Page Coming Soon™).

Purchasing a Subscription

Now lets see how it looks for a user thinking about buying the description!

Below you can see details about the subscription. The tiers are shown and the prices. It would be best to describe what each tier has access too as done in the description. Users can select the tier they wish to subscribe too as well as the subscription length. Once they have sufficient funds, they can quickly just purchase the subscription.

image

After having purchased the subscription, this is what the menu will look like: image

Users have the option to make requests or extend their subscription.

Let’s make a request! In this case we did not define the parameters since they don’t exist on the api. The user can simply select the options and make a request.

image

Each request costs a small fee to cover blockchain costs. After a request is made, they can track it in the download center. The request is sent to an adapter which makes a request using the access key provided earlier, the response is then encrypted with the users public key and sent back. This means each response is uniquely encrypted to each accounts key so only the user can read the data received ensuring access only to subscribed users. When it is ready, it will show a green check mark and a download icon.

image