swagger-client

ProductSearch Api

This Python package is automatically generated by the Swagger Codegen project:

• API version: v4
• Package version: 1.0.0
• Build package: io.swagger.codegen.languages.PythonClientCodegen For more information, please visit https://developer.digikey.com/support

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

If the python package is hosted on Github, you can install directly from Github

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import dk_api_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 dk_api_client

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function
import time
import dk_api_client
from dk_api_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: apiKeySecurity
configuration = dk_api_client.Configuration()
configuration.api_key['X-DIGIKEY-Client-Id'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-DIGIKEY-Client-Id'] = 'Bearer'
# Configure OAuth2 access token for authorization: oauth2ApplicationSecurity
configuration = dk_api_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = dk_api_client.ProductSearchApi(dk_api_client.ApiClient(configuration))
product_number = 'product_number_example' # str | The product to retrieve substitutions for.
x_digikey_client_id = 'x_digikey_client_id_example' # str | The Client Id for your App.
x_digikey_locale_site = 'x_digikey_locale_site_example' # str | Two letter code for Digi-Key product website to search on. Different countries sites have different part restrictions, supported languages, and currencies. Acceptable values include: US, CA, JP, UK, DE, AT, BE, DK, FI, GR, IE, IT, LU, NL, NO, PT, ES, KR, HK, SG, CN, TW, AU, FR, IN, NZ, SE, MX, CH, IL, PL, SK, SI, LV, LT, EE, CZ, HU, BG, MY, ZA, RO, TH, PH. (optional)
x_digikey_locale_language = 'x_digikey_locale_language_example' # str | Two letter code for language to search on. Langauge must be supported by the selected site. If searching on keyword, this language is used to find matches. Acceptable values include: en, ja, de, fr, ko, zhs, zht, it, es, he, nl, sv, pl, fi, da, no. (optional)
x_digikey_locale_currency = 'x_digikey_locale_currency_example' # str | Three letter code for Currency to return part pricing for. Currency must be supported by the selected site. Acceptable values include: USD, CAD, JPY, GBP, EUR, HKD, SGD, TWD, KRW, AUD, NZD, INR, DKK, NOK, SEK, ILS, CNY, PLN, CHF, CZK, HUF, RON, ZAR, MYR, THB, PHP. (optional)
x_digikey_customer_id = 'x_digikey_customer_id_example' # str | Your Digi-Key Customer id. If your account has multiple Customer Ids for different regions, this allows you to select one of them. (optional)

try:
    # Retrieve Associations for a given product
    api_response = api_instance.associations(product_number, x_digikey_client_id, x_digikey_locale_site=x_digikey_locale_site, x_digikey_locale_language=x_digikey_locale_language, x_digikey_locale_currency=x_digikey_locale_currency, x_digikey_customer_id=x_digikey_customer_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProductSearchApi->associations: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api.digikey.com/products/v4

Documentation For Models

• BaseFilterV3
• BaseProduct
• BreakPrice
• CategoriesResponse
• Category
• CategoryNode
• CategoryResponse
• Classifications
• DKProblemDetails
• Description
• DigiReelPricing
• FilterId
• FilterOptions
• FilterOptionsRequest
• FilterValue
• IsoSearchLocale
• KeywordRequest
• KeywordResponse
• Manufacturer
• ManufacturerInfo
• ManufacturersResponse
• MediaLinks
• MediaResponse
• PackageType
• PackageTypeByQuantityProduct
• PackageTypeByQuantityResponse
• Parameter
• ParameterFilterOptionsResponse
• ParameterFilterRequest
• ParameterValue
• ParametricCategory
• PriceBreak
• Product
• ProductAssociations
• ProductAssociationsResponse
• ProductDetails
• ProductStatusV3
• ProductSubstitute
• ProductSubstitutesResponse
• ProductSummary
• ProductVariation
• Recommendation
• RecommendedProduct
• RecommendedProductsResponse
• Series
• Supplier
• TopCategory
• TopCategoryNode

Documentation For Authorization

apiKeySecurity

• Type: API key
• API key parameter name: X-DIGIKEY-Client-Id
• Location: HTTP header

oauth2ApplicationSecurity

• Type: OAuth
• Flow: application
• Authorization URL:
• Scopes: N/A

Author

dl_Agile_Team_B2B_API@digikey.com