Skip to content
  • There are no suggestions because the search field is empty.

API: Use cases

The following article will outline when to use the different aspects of the API. 

The examples here are not production-ready since they don’t include error checks - they are merely intended as a launching pad for your integrations.

Where possible, we provide examples in multiple programming languages:

Bash examples are written primarily for the Ubuntu distro, with dependencies on cURL, jo and jq.

🚨Warning: Some Bash examples do not include URL-encode parameters correctly, for instance, when variables are embedded in URLs.

This is to keep the example clear - for production use, you should always encode user input.

C# examples are written primarily for .NET Framework using the client generated with Swagger Codegen tool.

In some examples, it depends on the HttpClient and JSON.NET libraries.

Where examples reference the fields _v1Configuration or _v2Configuration, They are referring to pre-authenticated instances of Configuration objects.

Select the following links for more details: