ReadAndWrite

ReadAndWrite

A read and write example for interacting with the Contracting Works API using C#.

Overview

Contracting Works provides a GraphQL endpoint endpoint for reading data and a REST endpoint for writing data. This example demonstrates how to interact with these endpoints using C#.

Based on our firsthand experience, we recommend using NSwag to generate a C# client for the REST API and Strawberry Shake for the GraphQL API.

Building the example

Open and build in visual studio or run the following in the terminal:

# Assuming you are in the root of the ReadAndWrite example folder

# Restore the graph QL tools
dotnet tool restore

# Build the example
#   Should build without errors
dotnet build

Secrets

Before running the example, you need to set up the necessary secrets to connect to your Contracting Works client.

Using Visual Studio

1. Right-click the C# project and select Manage User Secrets.
2. Add the following information:

{
  "contractingWorks": {
    "clientId"          : "<YOUR_CLIENT_ID>",
    "subjectId"         : "<YOUR_USER_SUBJECT_ID>",
    "apiKey"            : "<YOUR_USER_API_KEY>",
  }
}

Using Command Line

# Setup the secrets
dotnet user-secrets set "contractingWorks:clientId" "<YOUR_CLIENT_ID>"
dotnet user-secrets set "contractingWorks:subjectId" "<YOUR_USER_SUBJECT_ID>"
dotnet user-secrets set "contractingWorks:apiKey" "<YOUR_USER_API_KEY>"

# List the secrets (optional)
dotnet user-secrets list

Running the example

You can run the example from Visual Studio or the terminal using the following command:

dotnet run

With some luck, the sample program will perform the following:

1. Successfully authenticate using Devinco Connect.
2. Retrieve 10 Payment Terms and 10 Customers from Contracting Works using the GraphQL API.
3. Modify the Payment Terms of the received 10 Customers through the REST API.

For further insights into refining your queries, working with Strawberry Shake and NSwag, refer to the DETAILED.md guide.