The Ding C# library provides convenient access to the Ding API from applications written in C#.
dotnet add package DingSDK
dotnet add reference path/to/DingSDK.csproj
Send an OTP code to a user's phone number.
using DingSDK;
using DingSDK.Models.Components;
var sdk = new Ding(security: new Security() {
APIKey = "YOUR_API_KEY",
});
CreateAuthenticationRequest req = new CreateAuthenticationRequest() {
CustomerUuid = "c9f826e0-deca-41ec-871f-ecd6e8efeb46",
PhoneNumber = "+1234567890",
};
var res = await sdk.Otp.CreateAuthenticationAsync(req);
// handle response
Check that a code entered by a user is valid.
using DingSDK;
using DingSDK.Models.Components;
var sdk = new Ding(security: new Security() {
APIKey = "YOUR_API_KEY",
});
CreateCheckRequest req = new CreateCheckRequest() {
AuthenticationUuid = "e0e7b0e9-739d-424b-922f-1c2cb48ab077",
CheckCode = "123456",
CustomerUuid = "8f1196d5-806e-4b71-9b24-5f96ec052808",
};
var res = await sdk.Otp.CheckAsync(req);
// handle response
Perform a retry if a user has not received the code.
using DingSDK;
using DingSDK.Models.Components;
var sdk = new Ding(security: new Security() {
APIKey = "YOUR_API_KEY",
});
RetryAuthenticationRequest req = new RetryAuthenticationRequest() {
AuthenticationUuid = "a74ee547-564d-487a-91df-37fb25413a91",
CustomerUuid = "3c8b3a46-881e-4cdd-93a6-f7f238bf020a",
};
var res = await sdk.Otp.RetryAsync(req);
// handle response
- Check - Check a code
- CreateAuthentication - Send a code
- Feedback - Send feedback
- Retry - Perform a retry
- Lookup - Perform a phone number lookup
You can override the default server globally by passing a server index to the serverIndex: number
optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:
# | Server | Variables |
---|---|---|
0 | https://api.ding.live/v1 |
None |
The default server can also be overridden globally by passing a URL to the serverUrl: str
optional parameter when initializing the SDK client instance. For example:
This SDK supports the following security scheme globally:
Name | Type | Scheme |
---|---|---|
APIKey |
apiKey | API key |
You can set the security parameters through the security
optional parameter when initializing the SDK client instance. For example:
using DingSDK;
using DingSDK.Models.Components;
var sdk = new Ding(security: new Security() {
APIKey = "YOUR_API_KEY",
});
CreateCheckRequest req = new CreateCheckRequest() {
AuthenticationUuid = "e0e7b0e9-739d-424b-922f-1c2cb48ab077",
CheckCode = "123456",
CustomerUuid = "8f1196d5-806e-4b71-9b24-5f96ec052808",
};
var res = await sdk.Otp.CheckAsync(req);
// handle response
Handling errors in this SDK should largely match your expectations. All operations return a response object or thow an exception. If Error objects are specified in your OpenAPI Spec, the SDK will raise the appropriate type.
Error Object | Status Code | Content Type |
---|---|---|
DingSDK.Models.Errors.ErrorResponse | 400 | application/json |
DingSDK.Models.Errors.SDKException | 4xx-5xx | / |
using DingSDK;
using DingSDK.Models.Components;
using System;
using DingSDK.Models.Errors;
var sdk = new Ding(security: new Security() {
APIKey = "YOUR_API_KEY",
});
CreateCheckRequest req = new CreateCheckRequest() {
AuthenticationUuid = "e0e7b0e9-739d-424b-922f-1c2cb48ab077",
CheckCode = "123456",
CustomerUuid = "8f1196d5-806e-4b71-9b24-5f96ec052808",
};
try
{
var res = await sdk.Otp.CheckAsync(req);
// handle response
}
catch (Exception ex)
{
if (ex is ErrorResponse)
{
// handle exception
}
else if (ex is DingSDK.Models.Errors.SDKException)
{
// handle exception
}
}
This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.
While we value open-source contributions to this SDK, this library is generated programmatically. Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!