Getting Started

Before you can upload you files you must get an API key. Currently while the program is in Beta there is no charge to use our service. It's 100% free, however once we launch V1 there may be a fee based on storage usage. You can get your API key by going to https://ipfs.ordo.so/register

Once you have registered, from the dashboard there will be a link to create your api key. Once you have created your API Key you can begin uploading files.

Our REST API can be interacted with using multiple languages. For simplicity we will use javascript in our documentation as it can be easily adapted to cURL, Php, Python, Ruby, and many others. We will add more examples as continue to build out this program.

The anatomy of an upload request

In order to upload a file you must submit a valid request that includes the following parameters

1. API Key - as a Bearer Token view Getting Started to get your API Key

2. Project ID project_id - A UUID that is generated client side to represent the project your files are associated with.

3. Asset ID asset_id - A UUID that is unique and generated client side to represent an identifier that is unique within your project. Our program will not allow you to upload a file if a file already exists with this UUID associated to it.

4. Item ID item_id - A UUID that does NOT have to be unique and is generated client side to represent a parent item of itself. Our system allows for multiple assets to utilize a single file as a reference point. For example, you could have 500 NFT's that all utilize a specific type of background trait. It would be overly redundant to store 500 copies of the same file representing the same thing. So our system allows a client to store 1 file to represent MANY records. Therefore in this type of setup, the Item ID would represent the ID of that background asset client side. And the Asset ID would represent the record that points to that item. How this would actually happen in our system is you would attempt to create 500 records using that background image, however it would create and store that image once. Our system would see that you were sending in a new request with the same item id but a different asset id. In this case it would bypass uploading the image again and would simply create a new record with a new url just for that asset, but would point to the same file. This allows for 500 independent records that are all unique in nature but all use the same single image. This drastically speeds up the upload time and retrieval time.

5. File file - This is the file that you are wanting to upload. It must be a valid file and be of the following filetypes

   1. png

   2. jpg

   3. jpeg

   4. gif

   5. bmp

   6. mp4

   7. json

Beta Program Limitations

Currently the following limitations are present during our beta launch

• File sizes are limited to 25 MB

• Multiple file uploads are not permitted. 1 file per request currently

• Removing files has not yet been added but will be available soon

• Documentation is limited, if you are using our program it should be expected that you are an experienced coder.