ddx-interactions-api

Interactions API documentation

Python client for the DDx Interactions API, generated from its OpenAPI specification.

• API version: v1
• Package version: 0.3.0
• Generator version: 7.10.0

For more information, please visit https://demexchange.com/.

For support for this package or the DDx Interactions API please contact us at api@demexchange.com

Requirements

Python 3.8+

Installation

pip install ddx-interactions-api

Then import the package:

import ddx_interactions_api

Changelog

API changes are recorded in the changelog, regenerated from a diff of the OpenAPI specification on each sync. Entries marked breaking require a change on the consumer side.

Reporting issues

This package is generated; edits to it are overwritten on the next spec sync. Report problems against the API specification rather than the generated code.

Getting Started

Validating an integration end to end? The UAT guide walks through install, authentication, submitting an interaction, and confirming it reached the Exchange.

import ddx_interactions_api
from ddx_interactions_api.rest import ApiException
from pprint import pprint

# Authentication is HTTP basic, with your API key in the password field and an
# empty username. The key has the form "<keyId>.<secret>".
#
# The host defaults to https://api.movementinfrastructure.org. Pass host= to target another server.
# See configuration.py for all supported parameters.
import os

configuration = ddx_interactions_api.Configuration(
    username = "",
    password = os.environ["DDX_API_KEY"],
)


# Enter a context with an instance of the API client
with ddx_interactions_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ddx_interactions_api.AuthenticationDetailsApi(api_client)
    version = '1' # str |  (default to '1')

    try:
        # Get authentication context
        api_response = api_instance.vversion_auth_me_get(version)
        print("The response of AuthenticationDetailsApi->vversion_auth_me_get:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AuthenticationDetailsApi->vversion_auth_me_get: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api.movementinfrastructure.org

Documentation For Models

• AcceptedInteractionDto
• AcceptedInteractionsDto
• ActivistCode
• ActivistCodeOutcomeDetails
• Address
• AddressChannelDetails
• CanvasserDetails
• CommitteeDetails
• CommunicationConsent
• CommunicationConsentOutcomeDetails
• CommunicationConsentStatus
• ContactInfo
• ContactMethod
• DynamicChannelDetails
• DynamicOutcomeDetails
• EventDetails
• EventRole
• EventSignup
• EventSignupOutcomeDetails
• EventSignupStatus
• EventSignupStatusValue
• ExchangeInteractionStatus
• ExchangeInteractionStatusDto
• ExchangeInteractionStatusDtoCursorPaginatedResponseDto
• ExternalApiKeyStatus
• ExternalApiKeyType
• ExternalTransactionStatus
• InitiativeDto
• InteractionDto
• InteractionDtoChannel
• InteractionDtoOutcomesDetailedInner
• InteractionErrorDto
• InteractionVanFieldsDto
• InteractionsBatchResultDto
• InteractionsDto
• InteractionsExternalApiTransactionDto
• InteractionsExternalApiTransactionDtoGetResponseDto
• InteractionsExternalApiTransactionLogDto
• MercuryDestinationVanApiKeyDto
• MinervaMetadataDto
• Outcome
• OutcomeDetailOperation
• PersonIdentifier
• ProblemDetails
• RejectedInteractionDto
• RejectedInteractionsDto
• SimpleDestinationDto
• SimpleMovementAppDto
• SimpleWorkspaceDto
• SurveyResponse
• SurveyResponseOutcomeDetails
• VanApiKeyDto
• VanDatabaseMode
• WhoAmIApiKeyDto
• WorkspaceTypeDto

Documentation For Authorization

Authentication schemes defined for the API:

Basic

• Type: HTTP basic authentication

Author

api@demexchange.com