Welcome

Hi there! Here you'll find everything you need to integrate with the View My Chain API. We'll cover all the terms and journeys required for you to make the most of the API. We also have an API reference for a granular look at all the available endpoints.

Specification

Our API follows the JSON API Specification so all our endpoints return JSON. It uses common HTTP verbs according to REST and uses HTTP Status Codes to indicate success or error. Our endpoints require HTTP Authentication.

Authentication

View My Chain will generate your access token on your behalf and send it to you to use. In future we will be allowing users to generate access tokens from within the application. You will need to pass your access token within the headers of your request to our API.

Authentication: Bearer <YOUR-ACCESS-TOKEN>

Scopes and Permissions

All access tokens inherit the permissions of the user attached to it; the role your user has is assigned by View My Chain during onboarding. For this reason our API does not currently use scopes to dictate what an API access token can and cannot do.

Glossary

To help you understand the terms a little more we have created a glossary of commonly used terms throughout our documentation.

Data Structure

To help visualise the terms better, we have put together a diagram of how our data relates to each other, so hopefully you'll be able to map your own data structure to ours.

Tutorials

To help you get started we have created a number of tutorials to help you create and import data into View My Chain. We will focus on getting your data in View My Chain and the go on to explain how you can use the data once it's in.

Creating a Listing

We'll look at how you can create a listing with some basic information and then go on to finding and filtering listings.

Milestones

Once you have a listing, you can start adding and updating milestones against that listings. This tutorial will cover the basics of createing and updating milestones, and then take a look at validation, and the knock-on effects of creating certain milestones.

Chaining

Now you've got some listings in, you'll presumably want to start chaining your listings with others. We'll also cover unchaining listings and checking chains.

Additional Listing Actions

This will cover what additional actions can be achieved with a listing, such as making a listing available, and completing a listing.

Notes

You may wish to start taking notes about the progression of you listing, this guide will show you how, and how you get notes for a listing and tagging notes.

Milestone States

This tutorial will explain what a milestone state is, what information it contains, and how it could be useful for you.