The set of projects code named Carbon.Examples.WebService are used for demonstrations and testing by Red Centre Software to publish the Carbon cross-tabulation API over a REST style web service.
The following links document how Carbon can be called from .NET platform apps, scripts and notebooks.
In all those hosting scenarios, Carbon is being invoked in‑process, that is, Carbon is effectively running as part of the calling application. Many popular programming languages such as Python, Java, Swift, JavaScript, etc, cannot make in‑process calls to Carbon because the language platforms have evolved in quite different ways.
The conventional way to bridge across different programming languages and platforms is to use a web service to publish an API, also known as a software interface. Carbon.Examples.WebService is a public web service published by Red Centre Software to make Carbon functionality available to remote applications running on any platform that can make REST compliant web calls. The Carbon Web API is published at the following address, with standard Swagger documentation:
https://rcsapps.azurewebsites.net/carbon/swagger/
The following interactive notebooks demonstrate how Carbon functionality can be accessed via the web service.
 |
Carbon.Example.Notebooks-Python Python notebook #01 feeds arrays of data into a Caron web service call which responds with JSON in the shape of a pandas dataframe. |
|
Carbon.Example.Notebooks-CS C# interactive notebook #10 uses the Carbon web service to authenticate, open a job and generate a cross-tabulation report. |
 |
How to Use Swagger to Test the Carbon API Endpoints This document describes how to access and execute the API endpoints as documented by Swagger. |
Return to the Development Portal
Last updated: 03-Oct-2022