Skip to main content

JSON Post API

Warning

This API method is under development, there may be changes to it. Please contact your customer representative to access the API method.

You can follow the instructions below to get the information of your contacts in XML format using the POST method of the HTTP protocol.

Address to request

POSThttps://api.iletimerkezi.com/v1/get-contact/json

Request Content (Body)

Content of the request if you are processing using API Key
{
"request": {
"authentication": {
"key": "",
"hash": ""
},
"contact": {
"id": ""
}
}
}

Definitions

The request to the server must be wrapped with the request tag. The definitions of the subtags of this tag are as follows:

authentication

It is the user information that must be sent in order to receive authorization for the requested operation. The alt tags are as follows:

  • key: API Key that you can create from the settings section should be written in this field after logging in to your iletimerkezi.com panel. It is required to be sent when making a request.

  • hash: After logging into your iletimerkezi.com panel, the hash generated using the API Key and Secret Key that you can create from the settings section should be written in this field. It is required to be sent when making a request.

contact

It contains the information of the person whose information you want. The alt tag is as follows.

  • id: Unique numeric value representing the person.

Server response

{
"response": {
"status": {
"code": "",
"message": ""
},
"contact": {
"id": "",
"name": "",
"surname": "",
"email": "",
"gsm": "",
"custom_fields": {
"custom_field": [{ "id": "", "value": ""}]
},
"groups": {
"group": [{"id": ""}]
}
}
}
}

Definitions

The response from the server is always wrapped in the response tag. The definition of subtags of this tag is as follows:

status

Contains information about the transaction status. The values ​​returned by this tag can also be obtained by looking at the header information of the HTTP response. This tag is returned by default on every request made. The alt tags are as follows

  • code: It is the numerical value that indicates the operation status.
  • message: Contains an informational message about the transaction status.

contact

Contains contact information. It doesn't repeat. The alt tags are as follows.

  • id: Indicates the unique numeric value that represents the person.

  • name: Indicates the name of the person.

  • surname: Indicates the surname of the person.

  • email: Represents the email address of the person.

  • gsm: refers to the person's mobile phone information.

  • custom_fields

    It refers to the directory fields defined for the person. The alt tags are as follows:

    • custom_field

      Indicates the directory area defined for the person. It repeats as many times as the defined area. The alt tags are as follows.
      • id: Unique numeric value representing the Contacts field.
      • value: Indicates the value held for the contact in the Contacts field.
      • custom_field_settings:
  • groups

    Contains groups that the person belongs to.

    • groups

      It contains the information of the group the person belongs to. It repeats as much as the group information it is included in.

      • id: Contains the unique numeric value representing the group.