Giter Club home page Giter Club logo

icecloud_api's Introduction

API Documentation for IceCloud

We wrote the documentation for IceCloud in Insomnia HTTP client which is free and open source client available for Windows, Linux and macOS. API Documentation in Insomnia client will bring you flexible and interactive experience while you are working on your own application with the IceCloud API.

Insomnia HTTP Client

Contents

Installation

  1. Download and install Insomnia HTTP client.
  2. Open Insomnia client and create new project via Git Clone button.
  3. Paste url address https://github.com/linkspreed/IceCloud_API into URL input and confirm the popup.
  4. Open newly created document and switch at center of the top navigation into Debug tab.
  5. That's all.

Environment Setup

To properly run all documented endpoints you have to set environment variables.

In the top left corner you will see Config dropdown menu, click on it and select Manage Environments. In Config environment you will see two variables which you have to edit on your own.

  1. base_url - The base url of your running server with IceCloud
  2. token - The authentication token generated in the IceCloud app or obtained via /api/login login route.

We are providing you 1 backend which you can set and play via Insomnia HTTP clients:

IceCloud:

https://icecloud.cf

Interface Explanation:

Interface is divided into three parts:

Left Sidebar

All IceCloud API endpoints sorted into multiple categories

Middle part

Contains URL address bar with 5 Tabs:

  1. Body of the request
  2. Request authorization with bearer token for all secured endpoints
  3. Queries for your request
  4. Header setup for sending requests
  5. Docs where you find explanations for current endpoint

Right Sidebar

The original response of the request which was sent

icecloud_api's People

Contributors

linkspreed avatar

Stargazers

 avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.