Getting started

Introduction

Welcome to the Rainex Restful API documentation! This API allows you to interact with Rainex's services and access data through HTTP requests. The API is designed to be user-friendly and scalable, catering to various use cases and integration needs.

Base URL

The base URL for all API requests is: https://api.rainex.io

HTTP Methods

The API supports five main HTTP methods:

GET: Used to retrieve information from the server. It is safe and idempotent.

POST: Used to send data to the server to create new resources. It is not idempotent.

PUT: Used to send data to the server to update or modify existing resources. It is idempotent.

DELETE: Used to delete a resource from the server, may change the server state.

PATCH: Used to modify a resource on the server. Provides an entity containing a list of changes to be applied to the resource requested

Project Names

Every request you make must have your project’s name in the request’s URL.

For example, if you have registered and your project’s name is: your-site-name-1

then your requests must begin with https://api.rainex.io/projects/your-site-name-1

How to interact with Rainex readme

If you would like to fill in the fields for a request, you can do so manually for each field:

Or use autocomplete:

To see the structure of the response results, click on the code of interest:

Or you can see an example answer:

Also, the request can be formed in various programming languages: