Dyspatch API Client
Project description
Dyspatch Python Client
Introduction
The Dyspatch API is based on the REST paradigm, and features resource based URLs with standard HTTP response codes to indicate errors. We use standard HTTP authentication and request verbs, and all responses are JSON formatted.
API Client Libraries
Dyspatch provides API Clients for popular languages and web frameworks.
-
API version: 2019.03
-
Package version: 2.0.0
-
Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen
For more information, please visit https://docs.dyspatch.io
Requirements.
Python 2.7 and 3.4+
Installation & Usage
pip install
pip install dyspatch-python
Then import the package:
import dyspatch_client
Setuptools
Install via Setuptools.
python setup.py install --user
(or sudo python setup.py install
to install the package for all users)
Then import the package:
import dyspatch_client
Getting Started
Please follow the installation procedure and then run the following:
from __future__ import print_function
import time
import dyspatch_client
from dyspatch_client.rest import ApiException
from pprint import pprint
# Configure API key authorization: Bearer
configuration = dyspatch_client.Configuration()
configuration.api_key['Authorization'] = 'Dyspatch_API_key'
configuration.api_key_prefix['Authorization'] = 'Bearer'
# create an instance of the API class
api_instance = dyspatch_client.TemplatesApi(dyspatch_client.ApiClient(configuration))
cursor = 'example_cursor' # str | A cursor value used to retrieve a specific page from a paginated result set. (optional)
try:
# List Templates
api_response = api_instance.templates_get(cursor=cursor)
pprint(api_response)
except ApiException as e:
print("Exception when calling TemplatesApi->templates_get: %s\n" % e)
Documentation for API Endpoints
All URIs are relative to https://api.dyspatch.io/
Class | Method | HTTP request | Description |
---|---|---|---|
LocalizationsApi | localizations_localization_id_get | GET /localizations/{localizationId} | Get Localization Object by ID |
TemplatesApi | templates_get | GET /templates | List Templates |
TemplatesApi | templates_template_id_get | GET /templates/{templateId} | Get Template by ID |
Documentation For Models
- APIError
- CompiledRead
- Cursor
- LocalizationMetaRead
- LocalizationRead
- TemplateMetaRead
- TemplateRead
- TemplatesRead
Documentation For Authorization
Bearer
- Type: API key
- API key parameter name: Authorization
- Location: HTTP header
Author
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for dyspatch_python-2.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 17c632308e9bf9520101bbd53bc1cfd07111800406ba8ca64685099af2576f2f |
|
MD5 | 6d22dba3593f5bec6cccea7813c79aa0 |
|
BLAKE2b-256 | bb270286ba70e9ef915cdb74762d5f33c64be6e8beec230528aa9f13e646568b |