Signature in TME API
Contents
1.2. 4 DS DATE AS WEEK already ordered from supplier e Week Integer null Standard delivery time in weeks e Year Integer Field served only with DS DATE AS WEEK status Week and Year makes expected warehouse delivery date Sample response Status ORM Data 1 Productlist 1 Symbol 0 5W LOV DeliveryList Amount 21400 Status DS AVAILABLE IN STOCK Week null Amount 8600 Status DS DELIVERY NEEDS CONFIRMATION Week 16 Symbol 1N4002 DeliveryList Amount 1 Status DS AVAILABLE _IN_STOCK Week null TME API 32 55 Products GetPrices This action returns a list of prices for specified product list This method is limited by the maximum number of symbols that can be submitted as an input to this action The maximum number of symbols is equal to 50 Returned prices are presented in currency specified as an input parameter for this action Currency In case of using a private token the Currency input parameter becomes optional and prices are returned in clients default currency defined during registration of account on website ww tme eu Information about product s price type net or gross can be found in PriceType key The list of supported currencies BGN CZK EUR GBP HUF PLN RON USD List of supported currencies is available in separate API action call Utils GetCountries Possible errors E_AUTHORIZATION_F
3. Electronic Components TME API User Manual Table of Content Table of Content API Changelog Introduction Notices Authentication Security information API communication Connection limits Signature in TME API TME customers authentication Auth Init Auth GetNonce Getting information about products Products statuses returned by API Products Search Products GetCategories Products GetDelivery Time Products GetPrices Products GetParameters Products GetPricesAndStocks Products GetProducts Products GetProductsFiles Products GetStocks Products GetSymbols Products GetSimilarProducts Products GetRelatedProducts Other methods Utils GetCountries Utils GetLanguages Utils Ping o oo uo O 11 12 16 17 19 20 21 23 28 30 32 34 36 38 41 43 45 47 50 51 52 53 55 TME API 3 55 TME API 4 55 API Changelog e 1 12 0 2015 07 04 NEW Actions Products GetProducts Products Search now contains additional data about product warranty e 1 10 3 2015 05 12 FIX Value in Multiples is identical as in MinAmount e 1 10 0 2015 04 16 NEW Action Products GetDelivery Time returns additional field Year for DS DATE AS WEEK status e 1 9 1 2015 03 05 FIX Photo and Thumbnail fields are null rathen than empty string when no product photo e 1 8 7 2015 02 17 CHANGE Products GetProductsFiles action now gives files in all avaiable languages with it s language and filesize info FIX Pro
4. Signature basis The basis for a signature is created in the course of connecting HTTP request elements in appropriate order Special attention should be drawn to the order of request elements that should be sorted in alphabetic order prior to encrypting e HTTP request method e g GET HEAD POST etc written in capital letters e The amp sign ASCII code 38 e The base sequence URI e The amp sign ASCII code 38 e Standardized enquiry parameters after encryption HTTP illustrative enquiry POST reguest b5 3 Host example com D 253Dga3 a amp c 40 amp a2 r 20b HTTP 1 1 Content Type application x www form urlencoded Authorization OAut oaut oaut oaut oaut oaut t oau c2 amp a3 2 q h realm i h_token Example h_consumer_key 9djdj82h48djs9d2 kkk9d7dh3k39sjv7 h_signature_method HMAC SHA1 h_timestamp 137131201 h_nonce 7d8f3e4a h_signature bYT5CMsGcbgUdFHObYMEfcx6bsw 3D for which the generated signature s basis looks as follows POST8 http 3A 2F 2Fexample com 2Freguest a2 3Dr 2520b 26a3 3D292520g 2643 3Da 26b5 3D 253D 25253D 26c 2540 3D 26c2 3D 260auth_consumer_ keys3D9djdj82h48djs9d2 260oauth_nonce 3D7d8f3e4a 26oauth_signature_m ethod 3DHMAC SHA1 26oauth_timestamp 3D137131201 26oauth_tokens3Dkkk 9d7dh3k39sjv7 TME API 14 55 An example at TME API At TME API the only available request method is POST The signature basis at TME AP
5. API communication uses HTTPS protocol API accepts POST method only URL address changes dependent on action name and response format API is available on https api tme eu API call will be handled correctly by the server only if e Response format is defined e URL address contains action name with prefix Request format https api tme eu prefix action_name response_format Sample URL addresses for API calls https api tme eu Products GetPrices json https api tme eu Products GetStocks xml Data API response data is sent in one of available formats XML or JSON Response is returned in UTF 8 encoding Dependent on chosen action reguired parameters set changes Each action details are described in API methods section Response formats API response contains data in JSON or XML format and additionally contains HTTP header Each successful reguest returns HTTP 200 status All other HTTP response statuses mean error Incorrect reguest In case of incorrect API request when response format is not defined or URL address doesn t define action error response will be returned Error will be returned as simple text E UNKNOWN REQUEST FORMAT or E API ACTION NOT SPECIFIED TME API 11 55 Connection limits For each API token there is a pool of 15 connections Each new connection performed with given API token substracts 1 from the pool Every second 5 connections return to the pool but the total number of them n
6. 27 NEW New action for TME customers authentication Auth Init NEW New action which returns similar products Products GetSimilarProducts FIX Added missing description of Language parameter returned from Products GetProducts action e 1 1 0 2013 06 18 NEW New action allows for searching products in TME offer Products Search NEW Actions allow for checking API status and listing supported languages or countries all in Utils namespace e 1 0 2 2013 03 07 FEATURE New parameter for fetching symbols of products only from specified category Name of new field is TME API 5 55 Categoryld Changes in Products GetSymbols action FEATURE Added description of connection limiting mechanism under Connection limits section e 1 0 1 2013 03 05 FEATURE Information about product s category a new field Categoryld in the returned data Changes in Products GetProducts action FEATURE Information about product s price type net or gross Name of new field is PriceType Changes in Products GetPrices and Products GetPricesAndStocks actions e 1 0 0 First stable API release 2013 02 01 TME API 6 55 Introduction This document is Transfer Multisort Elektronik Sp z 0 0 API specification dedicated for Developers who want to use API in their applications To understand it you should be familiar with basics of HTTP protocol and XML and JSON formats All examples shown in this manual were pre
7. 50 characters You can create private token by linking anonymous token with customer account on www tme eu service Developer can link an account with anonymous token in TME API panel Private token should not be shown to anybody nor displayed in public Person who takes over private token will be able to call API using customer account on www tme eu In case of losing private token you should disable it immediately You can disable private token in www tme eu panel by logging in to customer account linked with that token Loosing private token doesn t mean the same as loosing www tme eu account password Basing on a private token customer of www tme eu service that is linked with this token can be fully identified If you lose your private key you should disable it immediately Suggested solution e Private token should not be stored as a simple text e If you store your private key in place to which other people have access to i e mobile phone memory you should use strong encrypting mechanism e If you don t need to show full private token it s recommended to show only few beginning characters TME API 9 55 Application secret Application secret is 20 characters long They appear under the name of app secret or application secret Generating a private application key is possible via TME API panel Generating a private application key is required to use TME API In case private application key is lost it should be immedia
8. Information about product s guarantee Can be null when there is no guarantee for this product e Type String Guarantee type can be period or lifetime e Period Integer Guarantee period in months This field may be equal 0 in case of lifetime guarantee e ProductStatusList Array of String List of product statuses TME API 26 55 Sample response Data Amount 2 CategoryList 10017912725 1 11000 27 11214052 I12141W 2 WSL OU 2 Fy PageNumber 1 ProductList statie ENS NIN Ena Symbol 1N4002 CustomerSymbol OriginalSymbol 1N4002 Producer DC COMPONENTS Description Diode rectifying 100V 1A DO41 CategoryId 113119 Category THT Universal Diodes Photo eu products_pics f c 8 c82c3993bd1e575e9e7 935e29e432c3 56940 jpg Thumbnail eu products_pics f c 8 c82c3993bd1e575e9e7 935e29e432c3 56940_t jpg Weight 0 325 SuppliedAmount MinAmount 25 Multiples 25 ProductStatusList Unaitits pes ProductInformationPage 2300 1 www tme eu pl details 1n4002 diody uniwersalne tht dc components statie tme MN Nf spatc e tme diodes Status Guarantee null QuotNumber Symbol 1N4007 CustomerSymbol DIODE 07 OriginalSymbol 1N4007 Producer DC COMPONENTS Description Diode rect
9. signature that is sent together with parameters to TME API under the parameter s name of ApiSignature The signature is generated based on the request parameters request method and URI More information concerning the manner of generating the signature is available in the Signature in API section Authentication using token To call API actions you have to pass anonymous or private token as a parameter TME API 8 55 Security information Security information contains reference about using tokens in API It is a knowledge base of good practices and information which Developer should be familiar with before implementing API communication Anonymous token This token has length of 45 characters It s generated by Developer in TME API panel Each application created in the panel is linked with one unique anonymous token Loosing anonymous token may allow other applications to call API acting as Developer s application Though anonymous key has low access level it s best to keep it in a safe place and don t show it to other people There is no risk of viewing Developer personal data or application by person who know anonymous token Exposing anonymous token can disrupt API call statistics or cause exceeding available API calls limit Suggested solution e Performing code obfuscation so that anonymous token is stored in a way preventing other people having access to its content Private token This token type has length of
10. 1 Application displays Nonce from Auth GetNonce action to the TME customer 2 TME customer logs on to the TME website to his Account Panel to register new application and provide received Nonce 1 3 TME Customer provides to the application temporary key received after putting Nonce on the TME website 4 Application sends temporary token 3 with Nonce 1 to Auth Init action 5 API action response will contain Token that can be used to access API on behalf of the TME customer First step can be replaced with redirecting TME customer to special URL address shown bellow for e g in a new browser window URL address for temporary token generation https www tme eu pl Profile Applications new nonce 1111111111 Nonce in URL should be replaced Developer s TME website TME customer application www tme eu TME API 1 Run application l 2 Call API action Auth GetNonce g mm TT TT T FRecebenonee TTTT 4 Display Nonce Temporary Token M 5 Open TME website and log in and Nonce are used only once to 6 Provide Nonce obtain TME d customer Token V k zm which should be 7 Receive Terhporary Token used as a primary Token 8 Provide Temporary Token 10 Receive TME customer Token TME customer authenticated 11 Show list of products Call API using TME 12 Call API action Products GetPloducts with TME customer Toke Customer Token NS ss 14 Display products 13 R
11. AILED E_AUTHENTICATION_FAILED E_SERVICE_UNAVAILABLE E_REQUIRED_INPUT_PARAMS_MISSING E_INPUT_PARAMS_VALIDATION_ERROR Request parameters Token String Anonymous or private token Country String Country identifier e g GB This field is required if you are using an anonymous token to authenticate For a private token this field is optional Language String Language identifier e g EN according to which returned amount symbol will be translated Currency String Currency identifier e g EUR according to which price values will be returned This field is required if you are using anonymous token SymbolList Array of String List of product symbols for which prices will be returned Maximum 50 symbols TME API 33 55 Response content e Status String Response status OK indicates that the action was successful e Data Object Action response data e Language String Language identifier e Currency String Currency of returned prices e PriceType Enum NET GROSS Price type Net or Gross e ProductList Array of Object Array of product objects e Symbol String Unique product identifier e Unit String Symbol of unit used to describe amount of product e g pcs pieces e PriceList Array of Object Array of price objects e Amount Integer Amount from current quantity threshold e PriceValue Float Price value for current quantity threshold e Special Boolean Special
12. E_UNAVAILABLE E_REQUIRED_INPUT_PARAMS_MISSING E INPUT PARAMS VALIDATION ERROR Request parameters Token String Anonymous or private token Country String Country identifier e g GB This field is required if you are using an anonymous token to authenticate For a private token this field is optional Language String Language identifier e g EN according to which returned paremeter names will be translated SymbolList Array of String List of product symbols for which similar products will be returned Maximum 50 symbols TME API 48 55 Response content e Status String Response status OK indicates that the action was successful e Data Object Action response data e ProductList Array of Object Array of product objects Symbol String Unique product identifier OriginalSymbol String Original product identifier Producer String Manufacturer name Description String Product description Offerld Integer ID of available offer Categoryld String Leaf category id in which the product is located Category String Leaf category name in which the product is located Photo String URL address of product image 640x480px Thumbnail String URL address of products thumbnail image 100x75px Weight Float Gross weight of 1 pcs of a product SuppliedAmount Integer Number of products supplied in one package MinAmount Integer The minimum amount of product tha
13. I in every case begins with the same text i e POST amp https api tme eu An illustrative URI for the Ping action in API looks as follows POST https api tme eu Utils Ping json in the encrypted form POST amp https 33A 32F 2Fapi tme eu 2FUtils 2FPing json Parameters are sent to API by means of POST method each of the parameters is attached to URI Request method POST URI https api tme eu Products GetStocks json Parameters SymbolList 0 1N4007 SymbolList 1 1 4W1 1M Language EN Token a94a8fe5ccb19ba61c4c0873d391e987982fbbd3 ApiSignature tkTK502VGvcBbDoqolXKq25Brqw Remember that the ApiSignature parameters should be deleted Parameters standardization and encryption remembering about alphabetical sorting Language EN amp SymbolList 5B0 5D 1N4007 amp SymbolList 5B1 5D 1 2F4W1 1M amp Token a94a8fe cc b19ba61c4c0873d391e987982fbbd3 URI together with the reguest method POST https api tme eu Products GetStocks json A ready basis of a signature i e encrypted URI sequence together with the request method and parameters POSTehttps 3A 2F9 2Fapi tme eu 2FProducts 2FGetStocks json Language 3DEN 26SymbolLi st 255B0 255D 3D1IN4007 26SymbolList 255B1 255D 3D1 252F4AW1 1M 26Token 3Da94a8fe cc b19ba61c4c0873d391e987982fbbd3 Remember that the HMAC SHA1 signature generated in the binary form should be encrypted by means of the Base64 function TME API 15 55 Gen
14. LIDATION_ERROR Request parameters Token String Anonymous or private token Country String Country identifier e g GB This field is required if you are using an anonymous token to authenticate For a private token this field is optional Language String Language identifier e g EN SymbolList Array of String List of product symbols for which files will be returned Maximum 50 symbols TME API 42 55 Response content e Status String Response status OK indicates that the action was successful e Data Object Action response data e ProductList Array of Object Array of product objects e Symbol String Unique product identifier e Files Array of Object Array of file objects e PhotoList Array of String Array of URLs leading to photos e DocumentList Array of Object Array of document objects e DocumentUrl String URL leading to the document e DocumentType String Document type e Filesize String Document size in bytes e Language String Document s content language Sample response Status OK Data ProductList Symbol 1N4005 Files PhotoList static tme eu products_pics a 9 3 edc9267037bb5db 1n4005 jpg 1 DocumentList 1 DocumentUrl www tme eu Document 0fb18890e16351 1N4005 pdf DocumentType DTE Filesize 484221 Language EN TME API 43 55 Products GetStocks This action returns a lis
15. List Array of Object Array of parameter objects e Symbol String Unique product identifier e Language String Language identifier used in action call e ParameterList Array of Object List of product parameters e Parameterld Integer Parameter identifier e ParameterName String Parameter name e ParameterValueld String Parameter value identifier e ParameterValue String Parameter value TME API 35 55 Sample response Status TOR Data ProductList Symbol 1N4005 ParameterList ParameterId 2 ParameterName Manufacturer ParameterValueld 45089 ParameterValue DC COMPONENTS ParameterId 10 ParameterName Mounting ParameterValueId 3244 ParameterValue THT Symbol 1N4007 ParameterList ParameterId 2 ParameterName Manufacturer ParameterValueId 45089 ParameterValue DC COMPONENTS ParameterId 10 ParameterName Mounting ParameterValueld 3244 ParameterValue THT 157 Language EN TME API 36 55 Products GetPricesAndStocks This action returns a list of prices and stock values for specified product list This method is limited by the maximum number of symbols that can be submitted as an input to this action The maximum number of symbols is equal to 50 Returned prices are presented in currency specified as an input parameter for t
16. ON FAILED E SERVICE UNAVAILABLE E REQUIRED INPUT PARAMS MISSING E INPUT PARAMS VALIDATION ERROR Request parameters Token String Anonymous or private token Language String Language identifier e g EN according to which returned paremeter names will be translated Symbol String Product symbol for which related products will be returned Response content e Status String Response status OK indicates that the action was successful e Data Object Action response data e ProductList Array of String Array of related products symbols Sample response Status ORT Data ProductList TO SA10 TO SA01 Tossa IDL MET2 GP IDL MPT3 CP IDESMETIR GET TME API 51 55 Other methods TME API 52 55 Utils GetCountries Action returns a list of countries supported by our system Possible errors E_AUTHORIZATION_FAILED E_AUTHENTICATION_FAILED E_REQUIRED_INPUT_PARAMS_MISSING E_INPUT_PARAMS_VALIDATION_ERROR Request parameters Token String Anonymous or private token Language String Language identifier e g EN according to which returned category list will be translated Response content e Status String Response status OK indicates that the action was successful e CountryList Complex Structure containing information about countries Countryld String Unique country identifier Name String Country name CurrencyList List Sup
17. S_MISSING E_INPUT_PARAMS_VALIDATION_ERROR Request parameters Token String Anonymous or private token Country String Country identifier e g GB This field is required if you are using an anonymous token to authenticate For a private token this field is optional Language String Language identifier e g EN according to which returned paremeter names will be translated SymbolList Array of String List of product symbols for which product details will be returned Maximum 50 symbols TME API 39 55 Response content e Status String Response status OK indicates that the action was successful e Data Object Action response data e ProductList Array of Object Array of product objects e Symbol String Unique product identifier e OriginalSymbol String Original product identifier e Producer String Manufacturer name e Description String Product description e Offerld Integer ID of available offer e Categoryld String Leaf category id in which the product is located e Category String Leaf category name in which the product is located e Photo String URL address of product image 640x480px e Thumbnail String URL address of products thumbnail image 100x75px e Weight Float Gross weight of 1 pcs of a product e SuppliedAmount Integer Number of products supplied in one package e MinAmount Integer The minimum amount of product that can be ordered e Multipl
18. age with search results On each page is presented up to 20 products SearchWithStock Boolean This param allows to filter products with stock only Filtering occurs according to data that can differ from actual data displayed on www tme eu TME API 25 55 Response content e Status String Response status OK indicates that the action was successful e Data Object Action response data e ProductList Array of Object Array of product objects e Symbol String Unique product identifier e OriginalSymbol String Original product identifier e Producer String Manufacturer name e Description String Product description e Offerld Integer ID of available offer e Categoryld String Leaf category id in which the product is located e Category String Leaf category name in which the product is located e Photo String URL address of product image 640x480px e Thumbnail String URL address of products thumbnail image 100x75px e Weight Float Gross weight of 1 pcs of a product e SuppliedAmount Integer Number of products supplied in one package e MinAmount Integer The minimum amount of product that can be ordered e Multiplies Integer Product multiplicity Product Quantity must be a multiple of this value e Unit String Symbol of unit used to describe amount of product e g pcs pieces e ProductlnformationPage String Product information URL address e Guarantee Array null
19. bTree TME API 30 55 Products GetDeliveryTime Action returns the approximate delivery times range Possible errors E_AUTHORIZATION_FAILED E_AUTHENTICATION_FAILED E_REQUIRED_INPUT_PARAMS_MISSING E INPUT PARAMS VALIDATION ERROR Request parameters Token String Anonymous or private token Country String Country identifier e g GB This field is required if you are using an anonymous token to authenticate For a private token this field is optional SymbolList Array of String List of product symbols for which data will be returned Maximum 50 symbols Amountlist Array of Integer List of amount for products given in SymbolList parameter Amounts order must match given SymbolList order TME API 31 55 Response content e Status String Response status OK indicates that the action was successful e Data Object Action response data e ProductList Array of Object Array of delivery times e Symbol String Unique product identifier e DeliveryList Array Array of delivery times for concrete product e Amount Integer The amount of product corresponding to the following status e Status String Information about availability 1 DS AVAILABLE IN STOCK Available n stock 2 DS DELIVERY NEEDS CONFIRMATION The term requires confirmation please contact our sales department 3 DS WAITING FOR CONFIRMATION FROM VENDOR We are waiting for confirmation of the delivery date
20. ducts statuses fixed DANGEROUS and others e 1 6 0 2014 12 08 FIX Occasionally empty response bugfix for prices actions CHANGE Change in path product s photos and thumbnails paths from katalog pics to products pics e 1 5 1 2014 11 17 FIX Parameter SearchWithStock in action Products Search now works e 1 5 0 2014 06 18 NEW New action Products GetDeliveryTime which returns the approximate delivery times range of products NEW New action Products GetRelatedProducts NEW Action Products GetCategories returns now a new parametr SubTreeCount integer FIX New optional Boolean parameter Tree in action Products GetCategories FIX New optional parameter Categoryld in action Products GetCategories FIX Parameter s type Depth returned in Products GetCategories action is now Integer e 1 3 1 2013 08 28 FIX Documentation update TME API signature generation code snippet moved to github com e 1 3 0 2013 08 22 NEW New action for Nonce generation needed in the TME customers authentication process Auth GetNonce Changes in authentication process NEW New parameter Nonce now is required in Auth Init action NEW HMAC SHA1 introduced as a new signing method used in API New parameter ApiSignature is now optional will be required from next version FEATURE New parameter returned from Products GetPrices and Products GetPricesAndStocks actions PriceList Special boolean e 1 2 0 2013 06
21. eceive list of products TME API 18 55 Possible errors E_AUTHORIZATION_FAILED E_AUTH_TOKEN_EXPIRED BE AUTH NOT SUCCESSFUL E AUTH TOKEN IS INVALID Request parameters Token String Anonymous token TempToken String Temporary Token generated by the TME customer on www tme eu website Response content e Status String Response status OK indicates that the action was successful e Data Object Structure containing action response e Token String Authenticated TME customer Token Sample response 1 Status TOR Data Token a94a8fe5ccb19ba61c4c0873d391e987982fbbd3a94a8fe5cc TME API 19 55 Auth GetNonce Action returns Nonce number used once required by Auth lnit action Nonce is used in the Authentication process of TME customers Nonce after generation is valid only for 600 seconds Possible errors E_AUTHORIZATION_FAILED E_AUTH_NOT_SUCCESSFUL E_AUTH_NONCE_NOT_GENERATED Request parameters Token String Anonymous token Response content e Status String Response status OK indicates that the action was successful e Data Object Structure containing action response e Nonce String Generated Nonce Sample response Status OK Data 1 once 7211B911B3 TME API 20 55 Getting information about products TME API 21 55 Products statuses returned by API API can return more than one status for each product Some statuse
22. erated HMAC SHA1 signature for private key with the test value after encryption by means of the Base64 function tkTK502VGvcBbDOqgolxXKq25Brqw A signature prepared in this manner is ready to be sent to TME API as ApiSignature parameter TME API code snippets https github com tme dev TME API A key to signature A key used while generating a signature is assigned to the application More information on this subject is available in the Application secret section HMAC implementation Below there is a list of HMAC implementations in most popular programming languages Language HMAC implementation PHP http ohp net manual en function hash hmac php http docs oracle com cd E23943 01 apirefs 111 1 e10668 oracle security crypto core HMAC html http developer android com reference javax cry Android pto package summary html Python http docs python org 2 library hmac html http msdn microsoft com en us library system se C i curity cryptography hmac aspx http stackoverflow com questions 756492 object ive c sample code for hmac sha1 Java Objective C TME API 16 55 TME customers authentication TME API 17 55 Auth Init Action returns Token on success This token can be used to access API on behalf of the TME customer Temporary token after generation on www tme eu website is valid only for 600 seconds After expiration E AUTH TOKEN EXPIRED error is returned TME customer authentication scheme
23. ever exceeds 15 API does not allow performing more of them per second In case of new connection try with the empty pool API responds with given header HTTP 1 1 509 Bandwidth Limit Exceeded Retry After 1 If you want to increase the limits for given API token please e mail us at developers tme eu TME API 12 55 Signature in TME API Signature is a unique footprint of a request sent to API It is always the same for the same set of parameters and for the same private key Signature helps avoid problems with communicating with API when in case of script error additional parameter that has not been expected is sent The use of a signature ensures integrity and authenticity of the data When incorrect signature is sent to TME API the E_INVALID_SIGNATURE error is returned The name of a parameter transferred to API is ApiSignature Generating signature Signature used in API is HMAC Keyed Hashing for Message Authentication whereas the name of shortcut function used while generating a signature is SHA 1 as a result we get HMAC SHAT The signature is generated in TME API in a way that is similar to the process of creating the OAuth 1 0a HMAC SHA1 signature Illustrative enquiry parameters and presented assumptions come from the RFC 5849 specification http tools ietf org hntml rfc5849 The HMAC SHA1 signature should be generated in the binary form and subsequently encrypted with the Base64 function TME API 13 55
24. his action Currency In case of using a private token the Currency input parameter becomes optional and prices are returned in clients default currency defined during registration of account on website ww tme eu Information about product s price type net or gross can be found in PriceType key The list of supported currencies BGN CZK EUR GBP HUF PLN RON USD List of supported currencies is available in separate API action call Utils GetCountries Possible errors E_AUTHORIZATION_FAILED E_AUTHENTICATION_FAILED E_SERVICE_UNAVAILABLE E_REQUIRED_INPUT_PARAMS_MISSING E_INPUT_PARAMS_VALIDATION_ERROR Request parameters Token String Anonymous or private token Country String Country identifier e g GB This field is required if you are using an anonymous token to authenticate For a private token this field is optional Language String Language identifier e g EN according to which returned amount symbol will be translated Currency String Currency identifier e g EUR according to which price values will be returned This field is required if you are using anonymous token SymbolList Array of String List of product symbols for which prices will be returned Maximum 50 symbols TME API 37 55 Response content e Status String Response status OK indicates that the action was successful e Data Object Action response data e Language String Language identifier e Currency Str
25. ies Integer Product multiplicity Product Quantity must be a multiple of this value e Unit String Symbol of unit used to describe amount of product e g pcs pieces e ProductlnformationPage String Product information URL address e Guarantee Array null Information about product s guarantee Can be null when there is no guarantee for this product e Type String Guarantee type can be period or lifetime e Period Integer Guarantee period in months This field may be equal 0 in case of lifetime guarantee e ProductStatusList Array of String List of product statuses e Language String Language identifier e g EN according to which returned paremeter names will be translated TME API 40 55 Sample response Status OK Data ProductList Symbol 1N4002 CustomerSymbol OriginalSymbol 1N4002 Producer DC COMPONENTS Description Diode rectifying 100V 1A DO41 CategoryId 113119 Category THT Universal Diodes Photo static tme eu products_pics c 8 c82c3993bd1e575e9e7 935e29e432c3 56940 jpg Thumbnail static tme eu products_pics c 8 c82c3993bd1e575e9e7935e29e432c3 56940_t jpg Weight 0 325 SuppliedAmount 2500 MinAmount 25 Multiples 25 ProductStatusList SORTENS PES ProductInformationPage www tme eu pl details 1n4002 diody uniwersalne tht dc components G
26. ifying 1kV 1A DO41 CategoryId 113119 Category THT Universal Diodes Photo eu products_pics f c 8 c82c3993bd1e575e9e7 935e29e432c3 56940 jpg Thumbnail eu products_pics f c 8 c82c3993bd1e575e9e7 935e29e432c3 56940_t jpg Weight 0 302 SuppliedAmount MinAmount 10 Multiples 10 ProductStatusList NORTE pest ProductInformationPage 0 www devel tme eu en details 1n4007 tht universal Guarantee W Type W R Period QuotNumber lifetime 0 un OK TME API 27 55 TME API 28 55 Products GetCategories Action returns a list of all product categories Returned data does not contain product relations with those categories but only a simple list of categories Possible errors E_AUTHORIZATION_FAILED E AUTHENTICATION FAILED E REQUIRED INPUT PARAMS MISSING E INPUT PARAMS VALIDATION ERROR Request parameters Token String Anonymous or private token Language String Language identifier e g EN according to which returned category list will be translated Country String Country identifier e g GB This field is required if you are using an anonymous token to authenticate For a private token this field is optional Categoryld Integer Optional ID of category that ll narrow action result to it and its children Tree Boolean Determines form of response If true then tree will be returned Param is op
27. ing Currency of returned prices e PriceType Enum NET GROSS Price type Net or Gross e ProductList Array of Object Array of product objects e Symbol String Unique product identifier e Unit String Symbol of unit used to describe amount of product e g pcs pieces e Amount Integer Amount of products in stock PriceList Array of Object Array of price objects e Amount Integer Amount from current quantity threshold e PriceValue Float Price value for current quantity threshold e Special Boolean Special price for the customer Sample response Status OK Data Language EN Currency PLN PriceType NET ProductList Symbol 1N4007 PriceList Amount 10 PriceValue 0 216 Special false Amount 50 PriceValue 0 0941 Special true Amount 500 PriceValue 0 042 Special false 1 Under pas Amount 1229518 TME API 38 55 Products GetProducts Action returns basic information about products currently available in our offer Parameters like description categories name and unit are translated according to Language input parameter value This method is limited by the maximum number of symbols that can be submitted as an input to this action The maximum number of symbols is equal to 50 Possible errors E_AUTHORIZATION_FAILED E_AUTHENTICATION_FAILED E_SERVICE_UNAVAILABLE E_REQUIRED_INPUT_PARAM
28. mbol 1N4005 Amount 38699 Unit Des 1 Symbol 1N4007 Amount 2573709 Unit pes TME API 45 55 Products GetSymbols Action returns a list of symbols of products available in the offer Possible errors E_AUTHORIZATION_FAILED E_AUTHENTICATION_FAILED E_SERVICE_UNAVAILABLE E_REQUIRED_INPUT_PARAMS_MISSING E INPUT PARAMS VALIDATION ERROR Request parameters Token String Anonymous or private token Country String Country identifier e g GB This field is required if you are using an anonymous token to authenticate For a private token this field is optional Language String Language identifier e g EN according to which returned amount symbol will be translated Categoryld String Category identifier for products group List of available categories is returned by Products GetCategories action Response content e Status String Response status OK indicates that the action was successful e Data Object Action response data e SymbolList Array of String Array of product symbols TME API 46 55 Sample response Status OK Data SymbolList MOLSON LOS F RS LTS OR OM IAV O OM LSV Lae a TME API 47 55 Products GetSimilarProducts Action returns similar products Consider that not all of the TME symbols have similar products Possible errors E_AUTHORIZATION_FAILED E_AUTHENTICATION_FAILED E_SERVIC
29. pared in PHP programming language API is closed system and you have to register developer account on https developers tme eu signup to obtain access After registering an account Developer can generate unlimited quantity of anonymous access tokens which allow using of API With anonymous tokens Developers can perform limited quantity of actions Full access to API is possible by using generated private token Notices We are still expanding our API and all comments about stability noticed bugs and usability are always welcome You can post you comments using link https developers tme eu dev issues the page is available after sign in In case of security error found please contact us directly by e mail security tme eu TME API 7 55 Authentication Introduction Authentication process uses token which enables access to API actions There are two different tokens available private and anonymous with different access level to API actions API tokens Anonymous token This token type is not linked with TME customer Using anonymous token you can perform API actions that are available without registering an account on www tme eu Anonymous token identifies application and Developer Private token This token type is created by linking anonymous token with customer account on www tme eu service and identifies application Developer and TME customer Application Secret Application secret is used to generate the HMAC SHA1
30. ported currencies Currency String Default currency for country Sample response Status OK Data CountryList CountryId Ar Name Afghanistan CurrencyList EUR USD 1 Currency EUR TME API 53 55 Utils GetLanguages Action returns a list of languages supported by our system Possible errors E_AUTHORIZATION_FAILED E_AUTHENTICATION_FAILED E_REQUIRED_INPUT_PARAMS_MISSING E INPUT PARAMS VALIDATION ERROR Request parameters Token String Anonymous or private token Response content e Status String Response status OK indicates that the action was successful e LanguageList Complex Structure containing information about languages e Languageld String Unique language identifier TME API 54 55 Sample response Status SOK Data LanguageList ann BEN NEE Nez DE F P T 7 PT TRON RUT vont V KT KERN VA TME API 55 55 Utils Ping Action returns a status of API Possible errors E_AUTHORIZATION_FAILED E_AUTHENTICATION FAILED Request parameters Token String Anonymous or private token Response content e Status String Response status OK indicates that the action was successful e Data Object Structure containing PING PONG response e PONG String PING PONG response Sample response 1 Status OK Data PONG PING PONG
31. price for the customer Sample response Status OK Data Language EN Currency PLN PriceType NET Producthist Symbol 1N4007 PriceList Amount 10 PriceValue 0 216 Special false Amount 50 PriceValue 0 0941 Special false Amount 500 PriceValue 0 042 Special true 1 Unit ges TME API 34 55 Products GetParameters Action returns a list of products parameters This method is limited by the maximum number of symbols that can be submitted as an input to this action The maximum number of symbols is equal to 50 Parameters names are translated according to value of input parameter Language Possible errors E_AUTHORIZATION_FAILED E_AUTHENTICATION_FAILED E_REQUIRED_INPUT_PARAMS_MISSING E_INPUT_PARAMS_VALIDATION_ERROR Request parameters Token String Anonymous or private token Country String Country identifier e g GB This field is required if you are using an anonymous token to authenticate For a private token this field is optional Language String Language identifier e g EN according to which returned parameter names will be translated SymbolList Array of String List of product symbols for which parameters will be fetched Maximum 50 symbols Response content e Status String Response status OK indicates that the action was successful e Data Object Action response data e Product
32. rking directories It cannot be added after removal We don not have any information about it API does not return a PiP link for it TME API 23 55 Products Search Action returns information about products that match search pattern The results are divided into pages with 20 items each The total number of products and the current page number is returned in the action response data the field Amount and PageNumber You can search for products only with stock with a particular description or to fetch all the products in the selected category Possible errors E_AUTHORIZATION_FAILED E_AUTHENTICATION_FAILED E_SERVICE_UNAVAILABLE E_REQUIRED_INPUT_PARAMS_MISSING E INPUT PARAMS VALIDATION ERROR FE SEARCH PHRASE AT LEAST ONE POSITIVE E SEARCH PHRASE TOO SHORT TME API 24 55 Request parameters Token String Anonymous or private token Country String Country identifier e g GB This field is required if you are using an anonymous token to authenticate For a private token this field is optional Language String Language identifier e g EN according to which returned amount symbol product description and category name will be translated SearchPlain String Text describing the searched product may consist of multiple words Example led diode cover 1N4007 SearchCategory String Category identifier in which the products should be searched such as 100328 SearchPage Integer Number of p
33. s indicate that not all data returned by API can be displayed for the user NEW A product should be marked as new SALE A product should be marked as sale PROMOTED A product should be marked as promotion DANGEROUS A product should be marked as dangerous AVAILABLE_WHILE_STOCKS_LAST A product contains an annotation Product being withdrawn from our offer HARDLY_AVAILABLE A product contains an annotation Hardly available product ONLY_FOR_SPECIAL_ORDER A product contains an annotation Product for special order CANNOT _BE_ORDERED A product contains an annotation This product is not available for sale in your country ACID A product contains an annotation Product for special order only for customers from Poland Additionaly it has to contain information about acid contents on our website it is labeled Due to the provisions of the Act on batteries and accumulators dated April 24 2009 please contact us to order this product For this kind of product we can display stock ONLY The price must stay hidden although it is returned by API TME API 22 55 NOT_IN_OFFER A product contains an annotation Product is not in our offer any more API should not return stock and prices for it We cannot display delivery time for it API returns PiP link for it which should be used INVALID A product contains an annotation Product is invalid This kind of product cannot be moved between pa
34. t can be ordered Multiplies Integer Product multiplicity Product Quantity must be a multiple of this value Unit String Symbol of unit used to describe amount of product e g pcs pieces ProductStatusList Array of String List of product statuses ProductinformationPage String Product information URL address e Language String Language identifier e g EN according to which returned paremeter names will be translated TME API 49 55 Sample response Status TOR Data ProductList Symbol AX 101 ProductList Symbol AX 100 OriginalSymbol AX 100M Producer AXIOMET Description Digital multimeter LCD 3 5 digit 1999 Samplingi3x s P40 GC CategoryId 112610 Category portable digital multimeters Photo static tme eu katalog_pics 2 8 7 2877b2306598c9d0ede906cf2da4e3ba ax 100 jpg Thumbnail static tme eu katalog_pics 2 8 7 2877b2306598c9d0ede906cf2da4e3ba ax 100_t jpg Weight 300 SuppliedAmount 1 MinAmount 1 Multiples 1 Unit DES ProductStatusList ProductInformationPage www tme eu en details ax 101 portable digital multimeters axiomet OfferId null 1 Language EN TME API 50 55 Products GetRelatedProducts Action returns related products Consider that not all of the TME symbols have related products Possible errors E_AUTHORIZATION_FAILED E AUTHENTICATI
35. t of stock values for specified product list This method is limited by the maximum number of symbols that can be submitted as an input to this action The maximum number of symbols is equal to 50 In case of using a private token it returns the current stock value For anonymous token it returns the stock value from the previous day Possible errors E_AUTHORIZATION_FAILED E_AUTHENTICATION_FAILED E_SERVICE_UNAVAILABLE E_REQUIRED_INPUT_PARAMS_MISSING E_INPUT_PARAMS_VALIDATION_ERROR Request parameters Token String Anonymous or private token Country String Country identifier e g GB This field is required if you are using an anonymous token to authenticate For a private token this field is optional Language String Language identifier e g EN according to which returned amount symbol will be translated SymbolList Array of String List of product symbols for which stock values will be returned Maximum 50 symbols Response content e Status String Response status OK indicates that the action was successful e Data Object Action response data e ProductList Array of Object Array of product objects e Symbol String Unique product identifier e Amount Integer Amount of products in stock e Unit String Symbol of a unit used to express the stock value of given product eg pcs number of pieces TME API 44 55 Sample response Status OK Data ProductList Sy
36. tely disabled It can be done via TME API panel Recommended solutions e Application secret should not be kept in the form of a clear text e When the key is kept in a place which other users or applications may access e g mobile phone memory it is recommended to use strong encryption e Application secret should not be displayed anywhere Safe communication Independent on how you secure tokens you should remember that data is transferred via the Internet finally which is often a target of attacks To reduce a risk of violating users privacy whole communication with API is secured by SSL connection using 256 bit key There is only SSL communication with API available Advantages of using encrypted communication All data transferred to API is automatically encrypted without additional Developer actions Better data security and integrity Often used and easy to implement solution e Ensures security of data transferred by the Internet Usage Secure SSL connection to API doesn t mean that connection is fully secured if Developer doesn t implement API communication in a proper way API certificate should be verified during the connection If API certificate is incorrect or expired communication should not be established It may be an attempt of scam abuse or MITM attack which can cause overtaking of key sent to API You can t accept incorrect or expired certificate TME API 10 55 API communication URL address
37. tional default true TME API 29 55 Response content e Status String Response status OK indicates that the action was successful e Data Object Action response data e CategoryTree Array of Object Array of category objects Id String Unique category identifier Parentld String Parent category identifier Depth Integer Tree depth level for the current category First depth level is 0 for category of identifier equals 111000 main category Name String Category name TotalProducts Integer Total number of products assigned to current category SubTreeCount Integer SubTree count Thumbnail String Category thumbnail URL address SubTree Array of Object Recursive call to CategoryTree Returned tree structure contains next branches of categories Value will be returned only for Tree 1 Sample response Status Data OK 7 CategoryTree TAN VIAN OOO ParentId 0 Depth 0 Name m a mm TotalProducts 101388 SubTreeCount 0 Thumbnail Mm SubTree 1 WE S112 140 ParentId 111000 Depth i m Al Name semiconductors TotalProducts 20684 SubTreeCount 12 Thumbnail static tme eu pics index 112140 jpg SubTree 1 Mas eA ParentId 112140 Depth 2 m i Name diodes SubTreeCount 5 TotalProducts 2489 Thumbnail static tme eu pics index 112141 jpg Su
38. uarantee null QuotNumber K Symbol 1N4007 CustomerSymbol DIODE 07 OriginalSymbol 1N4007 Producer DC COMPONENTS Description Diode rectifying 1kV 1A DO41 CategoryId 113119 Category THT Universal Diodes Photo static tme eu products_pics c 8 c82c3993bd1e575e9e7 935e29e432c3 56940 jpg Thumbnail static tme eu products_pics c 8 c82c3993bd1e575e9e7 935e29e432c3 56940_t jpg Weight 0 302 SuppliedAmount 0 MinAmount 10 Multiples 10 ProductStatusList Onit Des ProductInformationPage www devel tme eu en details 1n4007 tht universal diodes Guarantee Type lifetime Period 0 t QuotNumber 1 f Language EN TME API 41 55 Products GetProductsFiles This action returns a list of additional photos and documents correlated with specified products This method is limited by the maximum number of symbols that can be submitted as an input to this action The maximum number of symbols is equal to 50 GetProductsFiles can return theese types of documents e INS Manual e DTE Documentation e KCH Safety Data Sheet e GWA Warranty e INB Safety instruction e MOV Video e YTB YouTube video e PRE Presentation e SFT Software Possible errors E_AUTHORIZATION_FAILED E_AUTHENTICATION_FAILED E_SERVICE_UNAVAILABLE E_REQUIRED_INPUT_PARAMS_MISSING E_INPUT_PARAMS_VA
Download Pdf Manuals
Related Search