API - Developer Platform

 

Create a powerful application with Turkishexportal.

The API provides the site members with the ability to access and manipulate the desired data from the platform. The API functions provide an infrastructure that can be easily implemented between any application or website and Turkishexportal . Many of the actions that members perform on the site, such as company update, add / modify / delete products, add / change / delete news and references, read / reply / delete messages, visitor reports are also available to users via API . API accepts requests in the form REST and accepts multiple respond type (XML, JSON).

Some information about using the API ;

  • Each request should have a correct and valid API Access code .
  • All methods can be sent with different parameters under a single URL, https://wwww.turkishexportal.com/api/1.0/ (1.0 version information and will change over time.)
  • If the read requests are GET, write requests (add, modify, delete) then POST must use.
  • All requests must contain the method parameter. A sample request, below as shown:

    https://www.turkishexportal.com/api/1.0/company/update

For any issues with API , you can contact us at info@turkishexportal.com .

Basic Concepts

The Basics Concepts page's API requirements are important to include error codes, general information, etc. We recommend starting with this section for the API . In the next stage, you can see the here methods you can use on the API . Finally, you should get a access code to integrate your API into your application.

Requests

  • You can get responses in the format you specify for Response Titles and API requests.
  • All reading [GET] and writing requests [POST] should have a valid access code .
  • The method parameter in the request must be one of those listed in methods .
  • Updating will only update [ update ] information for valid parameters that have been sent, other information will be preserved.
  • For all numeric parameters that must be sent with decimal point, dot [.] will be used as the decimal separator. Example: 1345.72
  • The date information should be in the format dd / mm / yyyy in the parameters to be sent. Example: 17/09/2005
  • Logical expressions are specified with the boolean statement, where 1 or 0 should be assigned.
  • You can set the language to work with the language parameter.

Responses

  • Replies are encoded in UTF-8 format.
  • In all responses timestamp information [yyyyMMddHHmmss] is sent. For example: 20091211153544
  • Review the Errors section for error codes and clarifications.

Paging

This allows the data to be sent in handleable sizes for requests that list count , page and current parameters. Things to consider in lists;

  • The number of record impressions per page in the replies given is the same as the number defined for your company membership.
  • The number of records in the response is count , the number of pages is page , and the active page number is sent in current
  • The data for the first page will be returned as long as the page value is not sent in the submitted requests.
  • There must be a value between the page parameter 1 and page . This will result in page requests that are not in this range.

Answer Types

Turkishexportal API can send responses in 2 different formats;

  • XML : Many programming languages are easily adaptable by language and platform.
  • JSON : Another type of response that is accepted by the eval function in Javascript, or by many programming languages.

How to Determine the Response Type

The type of response to be received is provided by the format parameter in the submitted request. When this parameter is not sent, the response is returned as standard JSON type. If you want to change it, you can specify the response type for each request by adding the format = xml or format = json parameter.

XML

XML responses are in a special XML format specified by Turkishexportal.

https://www.turkishexportal.com/api/1.0/company/select?key=123&type=xml

Sample request - Truncated

<?xml version="1.0"?>
<Company xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <accountype>F</accountype>
  <active>Y</active>
  <alias>test</alias>
  <businesstype>01</businesstype>
  <communication>
    <address1>Ahmet Sokak. Aykon Apt.</address1>
	.
	.
	.
</Company>

JSON

JSON ( JavaScript Object Notation , json.org ) is a simple and useful data declaration format. It is used extensively in Ajax applications, especially those used within the browser.

https://www.turkishexportal.com/api/1.0/company/select?key=123&type=json

Sample request - Truncated

{
    "accountype":"F",
    "active":"Y",
    "alias":"test",
    "businesstype":"01",
    "communication":{  
        "address1":"Ahmet Sokak. Aykon Apt.",    
    .
    .
    }
}

Parameters

The parameters in this page are also used from time to time in definitions in the portal.

Name Code Description
TL 04 Assistant Export & Sales Manager
05 Assistant Export Manager
06 Assistant General Manager
10 Assistant Sales Manager
101 General Manager
103 International Marketing Assistant
104 International Marketing Manager
109 International Sales Manager
116 Manager
118 Managing Director
123 Marketing & Sales Representative
128 Marketing Manager
129 Marketing Representative
13 Business Development Manager
139 Owner
14 Business Development Specialist
143 Partner
160 Representative
161 Sales & Export Director
162 Sales & Export Manager
164 Sales & Marketing Manager
17 CEO
170 Sales Manager
171 Sales Representative
35 Director
36 Director of Business Development
37 Director Of Export & Import
38 Director of Sales & Logistics
46 Export & Import Assistant
48 Export & Import Manager
49 Export & Import Representative
62 Export Director
65 Export Manager
69 Export Representative
72 Export Sales Representative
82 Foreign Sales Manager
83 Foreign Sales Representative
92 Foreign Trade Manager
95 Foreign Trade Representative
98 Founder / Manager
Name Code Description
ER 01 1-10
02 10 - 50
03 50 - 100
04 100 - 250
05 > 250

Access Code

All access should be sent in the all requests apikey field via the Turkishexport API . Please keep your access code in a safe place. Keep in mind that your data security will be compromised if you have the code provided within your membership. In such cases, you must ensure that your code is canceled by contacting info@turkishexportal.com via email. A sample request with API Access Code is shown below.

https://www.turkishexportal.com/api/1.0/company/select?format=xml&apikey=f893a3bf3cfc432a8e304f07e5ea11f5

The apikey used in the above example is not a valid access code. It is given only in terms of being an example. Please use the apikey API Access Code assigned specifically to you in your own application.

Method List

Company

Update
Field Description Type
name Company Name Varchar [100]
<?xml version="1.0"?>
<Company xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <uid>33d27f2c6ed0403f98ab0219e3fec20e</uid>
  <name>Test Co Ltd.</name>
  <history>Test is the company that provides the best product.</history>
  <email>info@test.com</email>
  <mf>M</mf>
  <representative>Test Person</representative>
  <establishdate>1965</establishdate>
  <businesstype>01</businesstype>
  <statistic>
    <itemscount>4</itemscount>
    <newscount>1</newscount>
    <referencecount>1</referencecount>
    <certificatecount>2</certificatecount>
  </statistic>
</Company>

Error List

Code Description
100 No Record Found
110 Please check invalid fields.
255 Error occured.

Code Execution

 

Back to Top