The Ding Python library provides convenient access to the Ding API from applications written in the Python language.
Ding: The OTP API allows you to send authentication codes to your users using their phone numbers.
The SDK can be installed using the pip package manager, with dependencies and metadata stored in the setup.py file.
pip install ding_api_clientSend an OTP code to a user's phone number.
importdingfromding.modelsimportcomponentss=ding.Ding(
api_key='YOUR_API_KEY',
)
res=s.otp.create_authentication(request=components.CreateAuthenticationRequest(
customer_uuid='cf2edc1c-7fc6-48fb-86da-b7508c6b7b71',
phone_number='+1234567890',
locale='fr-FR',
))
ifres.create_authentication_responseisnotNone:
# handle responsepassCheck that a code entered by a user is valid.
importdingfromding.modelsimportcomponentss=ding.Ding(
api_key='YOUR_API_KEY',
)
res=s.otp.check(request=components.CreateCheckRequest(
customer_uuid='eebe792b-2fcc-44a0-87f1-650e79259e02',
authentication_uuid='64f66a7c-4b2c-4131-a8ff-d5b954cca05f',
check_code='123456',
))
ifres.create_check_responseisnotNone:
# handle responsepassPerform a retry if a user has not received the code.
importdings=ding.Ding(
api_key='YOUR_API_KEY',
)
res=s.otp.retry()
ifres.retry_authentication_responseisnotNone:
# handle responsepassSend feedback about the authentication process.
importdingfromding.modelsimportcomponentss=ding.Ding(
api_key='YOUR_API_KEY',
)
res=s.otp.feedback(request=components.FeedbackRequest(
customer_uuid='cc0f6c04-40de-448f-8301-3cb0e6565dff',
phone_number='+1234567890',
status=components.FeedbackRequestStatus.ONBOARDED,
))
ifres.feedback_responseisnotNone:
# handle responsepassGet the status of an authentication.
importdings=ding.Ding(
api_key='YOUR_API_KEY',
)
res=s.otp.get_authentication_status(auth_uuid='d8446450-f2fa-4dd9-806b-df5b8c661f23')
ifres.authentication_status_responseisnotNone:
# handle responsepassPerform a phone number lookup.
importdings=ding.Ding(
api_key='YOUR_API_KEY',
)
res=s.lookup.lookup(phone_number='<value>', customer_uuid='69a197d9-356c-45d1-a807-41874e16b555')
ifres.lookup_responseisnotNone:
# handle responsepassAvailable methods
- lookup - Look up for phone number
- create_authentication - Send a code
- check - Check a code
- feedback - Send feedback
- get_authentication_status - Get authentication status
- retry - Perform a retry
Handling errors in this SDK should largely match your expectations. All operations return a response object or raise an exception.
By default, an API error will raise a errors.SDKError exception, which has the following properties:
| Property | Type | Description |
|---|---|---|
.status_code | int | The HTTP status code |
.message | str | The error message |
.raw_response | httpx.Response | The raw HTTP response |
.body | str | The response content |
When custom error responses are specified for an operation, the SDK may also raise their associated exception. You can refer to respective Errors tables in SDK docs for more details on possible exception types for each operation. For example, the create_authentication method may raise the following exceptions:
| Error Type | Status Code | Content Type |
|---|---|---|
| errors.ErrorResponse | 400 | application/json |
| errors.SDKError | 4XX, 5XX | */* |
importdingfromding.modelsimportcomponents, errorss=ding.Ding(
api_key='YOUR_API_KEY',
)
res=Nonetry:
res=s.otp.create_authentication(request=components.CreateAuthenticationRequest(
customer_uuid='cf2edc1c-7fc6-48fb-86da-b7508c6b7b71',
phone_number='+1234567890',
locale='fr-FR',
))
excepterrors.ErrorResponsease:
# handle exceptionraise(e)
excepterrors.SDKErrorase:
# handle exceptionraise(e)
ifres.create_authentication_responseisnotNone:
# handle responsepassThe default server can be overridden globally by passing a URL to the server_url: str optional parameter when initializing the SDK client instance. For example:
importdingfromding.modelsimportcomponentss=ding.Ding(
server_url='https://api.ding.live/v1',
api_key='YOUR_API_KEY',
)
res=s.otp.create_authentication(request=components.CreateAuthenticationRequest(
customer_uuid='cf2edc1c-7fc6-48fb-86da-b7508c6b7b71',
phone_number='+1234567890',
locale='fr-FR',
))
ifres.create_authentication_responseisnotNone:
# handle responsepassThe Python SDK makes API calls using the requests HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with a custom requests.Session object.
For example, you could specify a header for every request that this sdk makes as follows:
importdingimportrequestshttp_client=requests.Session()
http_client.headers.update({'x-custom-header': 'someValue'})
s=ding.Ding(client=http_client)This SDK supports the following security scheme globally:
| Name | Type | Scheme |
|---|---|---|
api_key | apiKey | API key |
To authenticate with the API the api_key parameter must be set when initializing the SDK client instance. For example:
importdingfromding.modelsimportcomponentss=ding.Ding(
api_key='YOUR_API_KEY',
)
res=s.otp.create_authentication(request=components.CreateAuthenticationRequest(
customer_uuid='cf2edc1c-7fc6-48fb-86da-b7508c6b7b71',
phone_number='+1234567890',
locale='fr-FR',
))
ifres.create_authentication_responseisnotNone:
# handle responsepassWhile 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!