re.alto API help documentation

What is the re.alto API marketplace?

The re.alto marketplace is a marketplace for digital energy products and services, delivered via APIs.

You can register as a provider or a consumer/user.

As a provider, your digital products via APIs are uploaded to the re.alto marketplace, where consumers can search for and subscribe to use your product(s).

 

Which API formats are supported?

Our platform is compatible with web-based (HTTP), ideally REST, APIs. SOAP is also supported.  We currently do not support message queues or other binary formats.

How do I subscribe to an API?

Browse/search for an API you would like to connect to. Click on “get access” to connect to an API. If the API is free, it does not require an access request and you can test it out immediately.

For all other APIs, you will be asked to sign the API provider’s legal terms and pricing terms (if applicable). Once the API provider accepts your subscription request, you will receive a subscription key and be able to use the API.

Can I transfer my existing product subscriptions to re.alto?

Yes. If you want to have one central module to manage all your subscriptions, you can transfer your existing subscription to re.alto. Please contact us at Contact Us, so we can arrange the setup for you and your product provider.  

What can I do if I do not yet have an API but want to provide my data?

Our consulting team is happy to help you. Please reach out to us via:  Contact Us

Alternatively, schedule a demo where our team can give you a virtual tour of re.alto and answer any questions you may have: Get a Demo

Is re.alto a reseller of digital products?

No, re.alto is not a reseller of digital products.  

Each product provider lists his specific terms and conditions, as well as the applicable pricing, for the use of the product. The commercial agreement is between the provider and user.  

As a provider can I control access to my data?

Yes. An advantage of the re.alto approach is that you, as a data provider, will need to approve any user requesting access to your data, before the user is able to use the API. This does not currently apply to free APIs.

What is an API ?

 An “Application Programming Interface” or API is an interface that connects different components, for example applications with data from hardware or user interface. In building applications, an API simplifies programming by abstracting the underlying implementation and only exposing objects or actions the developer requires.

I do not have a standard price for my product. Can I just list my product without a price indication?

To list your APIs/data on re.alto, it is necessary to provide a price.   If our current pricing module does not offer what you need, please contact us via Contact Us, so we can help you find a solution. We also recommend offering free trials for potential subscribers, although this is not obligatory.

What if a user does not comply to my product terms and conditions?

Reach out to us via Contact Us.  At your request, we will revoke that user’s access to your product. For all paid APIs, users will have to request access before being able to begin using the API. This gives providers the opportunity to screen users before accepting their access request.

How do I make changes to my APIs/Products?

If you would like to make any changes to your API, please get in touch with us here: Contact Us

How do I call an API using my subscription key?

Follow the guidelines outlined within the specific API’s documentation regarding endpoints and parameters.

For authentication/authorisation all requests made to a specific API must include the subscription key in the header. The header key must be “Ocp-Apim-Subscription-Key” with the value being the subscription key.

As a Consumer, I have a requirement for an API I cannot find on the Marketplace. Can you help?

We regularly add new APIs to our marketplace! If you can’t find the API you need, please contact us here and let us know:  Contact Us

How can I invoice my clients?

re.alto  will manage the billing and settlement. You will initially be invoiced per transaction. You’ll then receive a monthly credit note/self-bill as a provider for all your sales on the re.alto marketplace.

re.alto uses Stripe for facilitating payments, which allows a direct transfer from the consumer to the provider. It is obligatory for providers to open a free Stripe account for this purpose.

Why do I have to upload a licence for users to access my product?

It is necessary to provide users of your data with a set of Terms and Conditions. We recommend that you use our standard template, which is based on the European Open Data Licence. If you have a question or a specific requirement, please contact us via Contact Us. 

 

How can I change my profile settings, for example email address or password?

Changes can be made on the “Your Profile” page. If you need any assistance, please contact us here: Contact Us

Do I need to change my product licence?

Yes, you most likely will have to change some parts of your standard product licence. For instance, consumers will no longer be reaching out to your base URL directly, rather they will connect to your service via re.alto’s gateway. Billing and payment will pass through re.alto, so you don’t have to worry about that anymore.

If you have any questions related to the compatibility of your terms & conditions with the functionality of re.alto, please simply contact us via Contact Us.

I am interested in becoming a Provider or user. How can I register?

You can join re.alto in the following ways:

Click on the ‘Add Your API’ button, found in the top right corner of the API Marketplace Portal: Register

Contact us here: Contact

Schedule a demo here: Get a Demo

 

My question is not answered here. Can you help?

We would be delighted to help…

Please contact us here using the email form: Contact Us

Or give us a call on any of these numbers:

BE: +32 2891 8072
UK: +44 203 608 8488
DE: +49 211 5401 4585
Thank you!