Introduction


This document is still work in progress - we are working on completing the documentation.

Apart from the Schedules and Group endpoints described below, we also now support Schedule Tags and RTI and Link Storage Values (you can see these described in the JSON Schema below).

 

The RapidiOnline API is organizsed around REST. Our API has predictable, resource-oriented URLs, and uses HTTP response codes to indicate API errors. We use built-in HTTP features, like HTTP authentication and HTTP verbs, which are understood by any off-the-shelf HTTP clients. The JSON format is used in POST and PUT requests and also returned by all API responses, including errors.

We support both JSON and JSON API standard 1.0 and we will provide examples of both languages thoughout the documentation. The JSON format is simple and minimalistic and can be used if you need to implement a few calls to our API and you are just coding the calls yourself. The JSON-API format is a standard that is supported by a number of tools. The overall functionality of the API is the same for both formats - same calls and same endpoints - you just specify which format to use when doing the request.

 

The code examples are formatted on several lines to be more reader-friendly, they must be written in one line for them to work. In general we use curl in all examples, but you can use any tool (or even program your own way of submitting the HTTP requests). All examples should work directly - just copy the example into a command prompt, substitute the Authorization token with your own (that you get using the Authentication request) and substitute the service id and data to something that you have access to through the normal myrapidi.com user interface. The URL's for the API generally terminate in the same way as the URL's in the normalt myrapidi.com user interface.


Our current version is called version 2 because we already have our SOAP based API.

 

Currently we have endpoints for Groups and for Schedules only. We will continue to add support for other endpoints and the goal is for you to be able to do everything that you can currently do through the normal MyRapidi.com user interface, through the REST API.

 

Below you will first have a walkthrough of some generic features of the API (that are the same for all endpoints) and after this, the documentation for each specific endpoint.

JSON Schema is a vocabulary that allows you to annotate and validate JSON documents.

The JSON Schema

  • describes your existing data format
...

 

This API is authenticated using HTTP Basic Auth over HTTPS. Any requests over plain HTTP will fail with a HTTP 307 Temporary Redirect error message. Use the ...

 

The base URL of the API is https://api.myrapidi.com/api/v2 All GET, POST, PUT, PATCH and DELETE requests are  ...

 

 

 

All response bodies are JSON or JSON API encoded.   JSON: A single resource is represented as a JSON object: ...

 

TODO: Still to be defined - please let us know if you have any problems with the current rate limiting ! The API ...

 

All GET requests can use filtering parameters to limit the response to only the data you need. Just pass in a filtering query parameter as shown ...

 

TODO: Still to be implemented Many endpoints support embedding related resources to minimize the number of required API round trips. By default, we ...

 

Schedules enables you to set up Transfers or Groups of Transfers to be run at certain intervals. Read more on how to use Schedules ...

 

Schedule Tags are used to specify the Tags (code and value) for each Schedule. When you create Schedules, you can select the Tag Values to be ...

 

+Groups    
Using Groups enables you can tie a given number of related Transfers together. This enables you to run an entire group of Transfers at once. ...

 

Connections are the databases or systems that you want to transfer data between. Read more about Connections.  
...

 

+RTI    
RTI (Run Time Information) is used to store SourceControl values. Read more about RTI   Schedules enable you to set up Transfers ...

 

 

Below you see an example on how to update a specific connection. Examples both in JSON and JSONAPI are provided. NOTE: ...

 

  1. Getting Started
  2. Documentation
  3. HowTo
  4. Standard Integrations

 

Service News can now be found on our Product Updates Blog 

 

Remember to Subscribe to our Product Updates Blog to receive updates and product news.

 

 

 

 

Wheeled by Wagn v. 1.9.1