Install the indico-client-csharp package via the NuGet package manager GUI or command line.
PM> Install-Package IndicoClient
The Indico Platform and Client Libraries use JSON Web Tokens (JWT) for user authentication. You can download a token
from your user dashboard by clicking the large, blue “Download new API Token” button.
Most browsers will download the API token as indico_api_token.txt and place it in your Downloads directory. You should move
the token file from Downloads to either your user profile (C:\Users\my-user) or another location in your development
environment. The C# Client Library will look in your user profile directory by default.
The IndicoConfig class gives you the maximum control over C# Client Library configuration. Here’s how you might instantiate an IndicoConfig object and set the host:
IndicoConfig config = new IndicoConfig(host: "app.indico.io");
You will most often provide a host argument to IndicoConfig. The class constructor also accepts tokenPath (path to a token file),
apiToken (the actual token string) and protocol (https).
The Indico Platform uses GraphQL to communicate with ALL clients including the company’s own web application and also the Indico Python Client. You’ll use an IndicoClient object to pass GraphQL queries to the Indico Platform. Here’s a simple way to create a client:
IndicoConfig config = new IndicoConfig(host: "app.indico.io");
IndicoClient indico = new IndicoClient(config);
The default config for IndicoClient sets the host to app.indico.io and will look for the Token File in your user profile directory.
If you want to learn more about GraphQL, the How to GraphQL tutorial is a great place to start.
The Indico Platform ships with a built-in sandbox environment that both documents and allows you to interactively explore
the Platform’s GraphQL schema. You can find the sandbox at /graph/api/graphql on your Indico Platform installation. If your
Platform’s host is indico.my_company.com then the full sandbox URL would be https://indico.my_company.com/graph/api/graphql.
GraphQL is extremely powerful, flexible and efficient but can be a bit verbose. To make things easier for day-to-day use of the Platform and Client Library, the developers at Indico created a collection of Python Classes to generate the most often used queries for you. You can find the collection documented in the Reference section of the Client Libreary Docs.
Several examples are provided in this repo:
SubmitWorkflows - How to submit a document to an Indico Workflow and retrieve results AddDataSetFiles - How to add new documents to an existing Dataset AmazonSQS - Sample code to listen to a workflow SQS and handle notifications
The examples are setup as console apps in the repo's Visual Studio project.
IndicoConfig config = new IndicoConfig(host: "app.indico.io");
IndicoClient indico = new IndicoClient(config);
It is highly recommended that developers set the following environment variables before running the integration tests.
INDICO_HOST: the host of the Indico instance you are testing against. Must include https://
INDICO_TOKEN: api token associated with the Indico host
INDICO_TEST_WORKFLOW_ID: Workflow id you are testing against
INDICO_TEST_DATASET_ID: Dataset id you are testing against
INDICO_TEST_MODELGROUP_ID: model group id you are testing against (NOT selected model id)
Notes for ID configs:
- You will want to ensure that all IDs come from the same dataset, eg the workflow id belongs to the dataset id provided.
- If these IDs are not provided, the integration tests will infer them by selecting the first dataset ID available to the user testing.
Further Notes retlated to failing tests: https://indicodata.atlassian.net/wiki/spaces/CATCE/pages/2685894671/C+Integration+Test+Enhancements https://indicodata.atlassian.net/wiki/spaces/CATCE/pages/2682748947/C+SDK+Integration+Tests+IPA+5.10