Contents


Version Information

MYSOFT IYS Api 2.10 version
Release Date: 11.01.2020
Release Notes
Source values have been added to webhook and historical record query services. "IYS_3338","IYS_CM", "IYS_WEB", "IYS_MOBIL","IYS_KISA_LINK"

MYSOFT IYS Api 2.7 version
Release Date: 30.11.2020
Release Notes
Retrospective Records Querying The call parameters of the method have been updated.
Status Inquiry With Recipient Information The call parameters of the method have been updated..

MYSOFT IYS Api 2.6 version
Release Date: 21.11.2020
Release Notes
Send Inquiry to Multiple IYS method has been updated. The isSendAllData parameter that allows returning all records belonging to the relevant transaction guid has been added to the method.

MYSOFT IYS Api 2.5 version
Release Date: 10.11.2020
Release Notes
The call address of the Status Inquiry With Recipient Information method has been updated.
A new method called Retrospective Records Querying was added.

MYSOFT IYS Api 2.4 version
Release Date: 11.10.2020
Release Notes
errorCode field is added for error codes.
The Webhook object has been added.
Method: 'Webhook'

MYSOFT IYS Api 2.3 version
Release Date: 04.09.2020
Release Notes
Multiple Message Delivery and Querying the Result of Multiple Message Sending calls have been updated.

New calls have been added under the name of Querying the Status of Multiple Message Sending
These Calls;

  1. Successful Records
  2. Incorrect Records
  3. Updated Records
  4. Unprocessed Records

In addition, we added 1 more method in which IYS sending status of adding multiple messages is checked.
This method also returns sending status to IYS.
  1. Send Inquiry to Multiple IYS

A new call has been added under the name Check Status with Recipient Information
It is the method that checks the status of the recipient information in the Mysoft system.

MYSOFT IYS Api 2.2 version
Release Date: 11.08.2020
Release Notes
A parameter related to direct sending to IYS has been added to the single message insertion call.
Parameter: 'isNotAutoSendIYS'

MYSOFT IYS Api 2.1 version
Release Date: 01.08.2020


Intro

In this document, Mysoft IYS API methods and call methods are explained.

 

MYSOFT IYS API Addresses:

 

TEST: https://iysapitest.mysoft.com.tr/

CANLI: https://iysapi.mysoft.com.tr/

 

Authentication OAuth 2.0 (Authentication Method)

MYSOFT IYS application uses OAuth 2.0 Authentication method.

First, you will be able to receive a Token by sending a request to our Service with the User Name and Password information you will receive from us, and then use this Token by switching to Headers information when making a request. The token type is Bearer.


Take Token with Username and Password

You can obtain the username and password you received from us and the Token that you can use in service calls by submitting a request as shown in the method below.

//Method POST

// https://iysapitest.mysoft.com.tr/ oauth/token


Parameters to be Sent

var parametre = {

    "username""Username",

    "password""Password",

    "grant_type""password"

}


Returning Result

You will need it for authentication when sending every request with the access_token data returned.

{

    "access_token""LMEO4PghTYBC9RF4MLxggpGX6xB65WSilL4ZYxIB2Yr891xmpjH1kJKn",

    "token_type""bearer",

    "expires_in"86399

}


Assigning to Header Feature when Submitting a Request

When making requests to Service Functions, we add Token to the "Authorization" parameter of the Headers definition.

'headers': {

    'Authorization''bearer YCR0ssRogif3b81K7TOKENQbAcTZKf0t1pTRS2K'

}

 

Jquery Example

var settings = {

  "url"" https://iysapitest.mysoft.com.tr /api/IYSConsent/IYSBrands",

  "method""GET",

  "timeout"0,

  "headers": {

    "Authorization""bearer YCR0ssRogif3b81K7QbAcT"

  },

};

 

$.ajax(settings).done(function (response) {

  console.log(response);

});


 

PHP Example

<?php

    $client = new http\Client;

    $request = new http\Client\Request;

    $request->setRequestUrl(' https://iysapitest.mysoft.com.tr/ api/IYSConsent/IYSBrands');

    $request->setRequestMethod('GET');

    $request->setOptions(array());

    $request->setHeaders(array(

    'Authorization' => 'bearer YCR0ssRogif3b81K7Qb'

    ));

    $client->enqueue($request)->send();

    $response = $client->getResponse();

    echo $response->getBody();

?>


Response Models

Single Result Returning Model (QueryResultModel<T>)

It is the model definition used in the single values ​​returned as a response in the service requests. Generic type takes an <T> parameter. Within this model, there is a 'succeed' parameter that indicates the result of the request. If this parameter is 'true', the request is successful and the requested data comes in the 'data' parameter of the model. But if the result is "false", it means the request failed and the "message" parameter that explains why the request failed, comes full. We can learn the cause of the error from the content of this parameter.

Public class QueryResultModel<T>

{

    public T data { getset; }

    public bool succeed { getset; }

    public string message { getset; }

}

 

Multiple Result Returning List Model (QueryResultList<T>)

Single Result works in the same way as the Returning Model, but returns a list value to the data parameter.

Public class QueryResultList<T>

{

    public List<Tdata { getset; }

    public bool succeed { getset; }

    public string message { getset; }

}

 

Example Control

var result = SampleServiceFunction();  //Receiving response from service

if(result.succeed){ //check succeed parameter

    ReadTheResult(result.data); //If true, reading the data in 'data' parameter.

}

else{

    ErrorPrint(result.message); //read error if 'false'

}


Brand Listing

With this method, you can access the name and code information of your brands under your account.

Method Access Information

//Access Method (Get)

//Test Environment:  https://iysapitest.mysoft.com.tr/api/IYSConsent/IYSBrands

 

Parameters When Submitting a Request

Only token information added to the Header of the request is sufficient.

Incoming Response Parameters (Multiple Result Returning List Model)

Response Parameters

Model Name

Model Type

Description

brandCode

Integer

IYS Brand Code

stats

Stats

This information gives the number of dealers and status statistics.

name

String

Brand name

master

Boolean

Information on whether the brand is the main brand
(True or False)


Stats Model

Stats

Parameter Name

Parameter Type

Description

consents

Consents

Model indicating the total number of approved leaves, rejection and Total leaves

retailers

Retailers

Total number of dealers registered under the brand


Consents Model

Consents

Parameter Name

Parameter Type

Description

approval

Integer

Total number of approved leaves

rejection

Integer

Total number of refusal permissions

total

Integer

Total number of permissions


Retailers Model

Retailers

Parameter Name

Parameter Type

Description

total

Integer

Total number of dealers registered under the brand


Sample Request and Response

Request (GET)

//GET {Mysoft Api Address}/api/IYSConsent/IYSBrands


Response

Successful

{[

    {

        "brandCode": 1232322,

        "stats": {

            "consents": {

                "approval": 22,

                "rejection": 0,

                "total": 22

            },

            "retailers": {

                "total": 4

            }

        },

        "name": "Test Marka 1",

        "master": true

    },

    {

        "brandCode": 123e22,

        "stats": {

            "consents": {

                "approval": 20,

                "rejection": 0,

                "total": 69

            },

            "retailers": {

                "total": 40

            }

        },

        "name": "Test Marka 2",

        "master": false

    }

]}

 

Failed

{

    "data" : null,

    "succeed"false,

    "message":"Error Message"

}


Single Message Delivery

Used for single message delivery.

Method Access Information

//Access Method (Post)

//Test Environment: https://iysapitest.mysoft.com.tr/api/IYSConsent/SendConsent

 

Parameters When Submitting a Request

Request Parameters

Model Name

Model Type

Description

brandCode

String

Brand Code

consentData

ConsentDataModel

Added Data Model (Singular)

isNotAutoSendIYS

Boolean

If true, it only saves to MYSOFT IYS. If False, it saves it to IYS and updates it in MYSOFT IYS.


ConsentDataModel

ConsentDataModel

Parameter Name

Parameter Type

Description

recipient

String

The citizen's phone number or e-mail information registered in the system. Email addresses cannot be longer than 284 characters long and phone numbers cannot exceed 15 characters.
The phone number must be in the format of +905813334455.
([+] [country code] [area code] [local phone number]) (+905555555555)

recipientType

String (ENUM)

It only takes 2 values. ("BIREYSEL", "TACIR"). Information showing the status of the merchant. (Default value: BIREYSEL)

type

String (ENUM)

It only takes 3 values. ("ARAMA", "MESAJ", "EPOSTA") It is the communication channel allowed by the citizen.

consentDate

String (date-time)

It is the date that the citizen determines the communication permit status. If the buyer type is TACIR, it does not have to be added. Sample Format (2018-02-10 09:30:00)

source

String (Enum)

It only takes 12 values. ("HS_FIZIKSEL_ORTAM", "HS_ISLAK_IMZA", "HS_WEB", "HS_CAGRI_MERKEZI", "HS_SOSYAL_MEDYA", "HS_EPOSTA", "HS_MESAJ", "HS_MOBIL", "HS_EORTAM", "HS_ETKINLIK", "HS_2015", "HS_ATM")

 

status

String (Enum)

Takes only 2 values ("ONAY", "RET")
Shows the citizen's permit status.

retailerCode

Integer (Nullable) (int?)

It is the İYS number assigned individually by the İYS to the dealer that mediates the permit.

retailerAccess

Integer Generic List (List<int>) 

It shows the list of İYS numbers assigned individually by the İYS to the dealers with permission access.


Incoming Response Parameters (Single Result Returning Model)

The consentData parameter that we fill in when making a request comes in the format of ConsentDataModel. Then the result of the addition is queried using the recipient, recipientType and type fields in this model.

Response Parameters

Model Name

Model Type

Description

recipient

String

It is the phone number or e-mail information of the citizen registered in the system.

recipientType

String (ENUM)

 ("BIREYSEL", "TACIR"). It is the information showing the status of the merchant.

type

String (ENUM)

("ARAMA", "MESAJ", "EPOSTA") It is the communication channel allowed by the citizen.

consentDate

String (date-time)

It is the date that the citizen determines the communication permit status.
Sample Format (2018-02-10 09:30:00)

source

String (Enum)

 ("HS_FIZIKSEL_ORTAM", "HS_ISLAK_IMZA", "HS_WEB", "HS_CAGRI_MERKEZI", "HS_SOSYAL_MEDYA", "HS_EPOSTA", "HS_MESAJ", "HS_MOBIL", "HS_EORTAM", "HS_ETKINLIK", "HS_2015", "HS_ATM")

status

String (Enum)

 ("ONAY", "RET") Shows the citizen's permit status.

retailerCode

Integer (Nullable) (int?)

It is the IYS number assigned individually by the IYS to the dealer that mediates the permission.

retailerAccess

Integer Generic List (List<int>) 

It shows the list of IMS numbers assigned individually by the IYS to the dealers with permission access.

 

Sample Request and Response

Request

//{Mysoft IYS Api Address}/api/IYSConsent/SendConsent
{

    "brandCode":"5565656556",

    "isNotAutoSendIYS": true,

    "consentData": {

        "recipient": "+905555555555",

        "recipientType": "BIREYSEL",

        "type": "MESAJ",

        "consentDate": "2018-02-10 09:30:00",

        "source": "HS_FIZIKSEL_ORTAM",

        "status": "ONAY",

        "retailerCode": 1553855,

        "retailerAccess": {5556665665656988595556656565568998855599}

    }

}


Response

Successful

{

    "succeed"true,

    "data": {

        "recipient": "+905555555555",

        "recipientType": "BIREYSEL",

        "type": "MESAJ",

        "consentDate": "2018-02-10 09:30:00",

        "source": "HS_FIZIKSEL_ORTAM",

        "status": "ONAY",

        "retailerCode": 1553855,

        "retailerAccess": {5556665665656988595556656565568998855599}

    },

    "message"null

}

 

Failed

{

    "succeed"false,

    "data"null,

    "message""Error Message"

}


Querying the Result of Single Message Delivery

Used to query the result of single message sending.

Method Access Information

//Access Method (Post)

//Test Environment: https://iysapitest.mysoft.com.tr/api/IYSConsent/ConsentStatus

 

Parameters When Submitting a Request

We fill the parameters with the Response information from the Single Message Sending Process described above.

Request Parameters

Model Name

Model Type

Description

brandCode

String

Brand Code

recipient

String

The citizen's phone number or e-mail information registered in the system.

recipientType

String

("BIREYSEL", "TACIR"). It is the information showing the status of the merchant.

type

String

("ARAMA", "MESAJ", "EPOSTA") It is the communication channel allowed by the citizen.

isQueryFromIYS

String

If True, it saves it to IYS and updates the information in MYSOFT IYS, if False only saves it to MYSOFT IYS.


Incoming Response Parameters (Single Result Returning Model)
The result of the Message Submission Process is learned according to the 'succeed' parameter of the Single Result Returning Model.

Response Parameters

Model Name

Model Type

Description

consentDate

String (date-time)

It is the first date that the customer (citizen) of the relevant brand gives permission for the message.
Sample Format (2018-02-10 09:30:00)

recipient

String

The citizen's phone number or e-mail information registered in the system.

recipientType

String (ENUM)

 ("BIREYSEL", "TACIR"). It is the information showing the status of the merchant.

status

String (Enum)

 ("ONAY", "RET") Shows the citizen's permit status.

type

String (ENUM)

("ARAMA", "MESAJ", "EPOSTA") It is the communication channel allowed by the citizen.

source

String (Enum)

 ("HS_FIZIKSEL_ORTAM", "HS_ISLAK_IMZA", "HS_WEB", "HS_CAGRI_MERKEZI", "HS_SOSYAL_MEDYA", "HS_EPOSTA", "HS_MESAJ", "HS_MOBIL", "HS_EORTAM", "HS_ETKINLIK", "HS_2015", "HS_ATM")

retailerAccessCount

Integer

Refers to the number of dealers who have access to permission.

retailerTitle

String

Refers to the name of the dealer that has access to permission.

retailerCode

Integer

It is the İYS number assigned individually by the İYS to the dealer that mediates the permit.

 

Sample Request and Response

Request (Post)

//{Mysoft IYS Api Address}/api/IYSConsent/ConsentStatus

 

{

    "brandCode":"5565656556",

    "recipient""+905555555555",

    "recipientType""BIREYSEL",

    "type""MESAJ",

    "isQueryFromIYS"true

}

 

Response

Successful

{

    "succeed"true,

    "data": {

        "consentDate" : "2018-02-10 09:30:00",

        "recipient" : "+905555555555",

        "recipientType" : "BIREYSEL",

        "status" : "ONAY",

        "type" : "MESAJ",

        "source" : "HS_FIZIKSEL_ORTAM",

        "retailerAccessCount" : 35,

        "retailerTitle" : "Firma LTD.",

        "retailerCode" : 1553855

    },

    "message"null

}

 

 

Failed

{

    "succeed" : false,

    "data" : null,

    "message" : "Error Message"

}


Multiple Message Delivery

Used for Multiple Message Sending. ConsentDataModel is added to ConsentData Parameter as a list. If the request is successful, the unique key (GUID) in String data type and ConsentDataInfoModel are returned. With this return key (GUID), the result of the Multiple Message Sending operation is queried. On the ConsentDataInfoModel, if there is an error in the data sent, it returns the error message with the data sent.In case of an incorrect record, all registrations are canceled and returned. If all entries are successful, succeed: true and the record list will be returned empty. 1000 records are accepted for sending multiple messages.

Method Access Information

//Access Method (Post)

//Test Environment: https://iysapitest.mysoft.com.tr/api/IYSConsent/SendConsentBatch

 

Parameters When Submitting a Request

Request Parameters

Model Name

Model Type

Description

brandCode

String

Brand Code

consentData

ConsentDataModel in Generic List

To add multiple, you can add this model more than once to a generic list.


ConsentDataModel

ConsentDataModel

Parameter Name

Parameter Type

Description

recipient

String

The citizen's phone number or e-mail information registered in the system. Email addresses cannot be longer than 284 characters long and phone numbers cannot exceed 15 characters.
The phone number must be in the format of +905813334455.
([+] [country code] [area code] [local phone number]) (+905555555555)

recipientType

String (ENUM)

It only takes 2 values. ("BIREYSEL", "TACIR"). Information showing the status of the merchant. (Default value: BIREYSEL)

type

String (ENUM)

It only takes 3 values. ("ARAMA", "MESAJ", "EPOSTA") It is the communication channel allowed by the citizen.

consentDate

String (date-time)

It is the date that the citizen determines the communication permit status. If the buyer type is TACIR, it does not have to be added. Sample Format (2018-02-10 09:30:00)

source

String (Enum)

It only takes 12 values. ("HS_FIZIKSEL_ORTAM", "HS_ISLAK_IMZA", "HS_WEB", "HS_CAGRI_MERKEZI", "HS_SOSYAL_MEDYA", "HS_EPOSTA", "HS_MESAJ", "HS_MOBIL", "HS_EORTAM", "HS_ETKINLIK", "HS_2015", "HS_ATM")

 

status

String (Enum)

Takes only 2 values ("ONAY", "RET")
Shows the citizen's permit status.

retailerCode

Integer (Nullable) (int?)

It is the İYS number assigned individually by the İYS to the dealer that mediates the permit.

retailerAccess

Integer Generic List (List<int>) 

It shows the list of İYS numbers assigned individually by the İYS to the dealers with permission access.

Incoming Response Parameters   (Single Result Returning Model)

If the result of Multiple Post Submission is successful, the 'succeed' field returns True, and if Multiple Post Submission is successful, the unique key (GUID) of String data type is returned. With this return key, the result of Multiple Message Sending is queried. In addition, if there is an error in the data sent on the ConsentDataInfoModel, the error message is returned with the data sent.


Response  Parametreleri (ConsentDataInfoModel)

Model Name

Model Type

Description

consentDate

String (date-time)

İlgili marka'nın müşterisinin (vatandaşın) ileti için izin verdiği ilk tarihtir.
Örnek Format (2018-02-10 09:30:00)

recipient

String

Vatandaşın sistemde kayıtlı telefon numarası veya e-posta bilgisidir.

recipientType

String (ENUM)

 ("BIREYSEL", "TACIR"). It is the information showing the status of the merchant.

status

String (Enum)

 ("ONAY", "RET") Vatandaşın izin durumunu gösterir.

type

String (ENUM)

("ARAMA", "MESAJ", "EPOSTA") It is the communication channel allowed by the citizen.

source

String (Enum)

 ("HS_FIZIKSEL_ORTAM", "HS_ISLAK_IMZA", "HS_WEB", "HS_CAGRI_MERKEZI", "HS_SOSYAL_MEDYA", "HS_EPOSTA", "HS_MESAJ", "HS_MOBIL", "HS_EORTAM", "HS_ETKINLIK", "HS_2015", "HS_ATM")

retailerAccessCount

Integer

Refers to the number of dealers who have access to permission.

retailerTitle

String

Refers to the name of the dealer who has access to permission.

retailerCode

Integer

It is the İYS number assigned individually by the İYS to the dealer that mediates the permit.

portalStatusText

String

Portal registration status description

portalStatus

Integer

Portal registration status

errorMessage

String

Error message



Sample Request and Response

Request (POST)

//{Mysoft IYS Api Address}/api/IYSConsent/SendConsentBatch

 

{

    "brandCode":"5565656556",

    "consentData": [

        {

            "recipient": "+905555555555",

            "recipientType": "BIREYSEL",

            "type": "MESAJ",

            "consentDate": "2018-02-10 09:30:00",

            "source": "HS_FIZIKSEL_ORTAM",

            "status": "ONAY",

            "retailerCode": 1553855,

            "retailerAccess": {5556665665656988595556656565568998855599}

        },

        {

            "recipient": "eposta@mail.com",

            "recipientType": "BIREYSEL",

            "type": "MESAJ",

            "consentDate": "2018-02-10 09:30:00",

            "source": "HS_FIZIKSEL_ORTAM",

            "status": "ONAY",

            "retailerCode": 1553855,

            "retailerAccess": {5556665665656988595556656565568998855599}

        }

    ]

}

 


 

Response

Successful

{

    "succeed"true,

    "data": {

        "transctionGuid" : "638bfa83-c188-47a3-81e6-4aef718d27c5",

        "consentList" : [

            {

                "recipient""+905555555555",

                "recipientType""BIREYSEL",

                "type""MESAJ",

                "consentDate""2018-02-10 09:30:00",

                "source""HS_FIZIKSEL_ORTAM",

                "status""ONAY",

                "portalStatusText" : "Incorrect phone information",

                "portalStatus" : 1,

                "errorMessage" : "The phone number must be entered correctly."

            },

            {

                "recipient""eposta@mail.com",

                "recipientType""BIREYSEL",

                "type""MESAJ",

                "consentDate""2018-02-10 09:30:00",

                "source""HS_FIZIKSEL_ORTAM",

                "status""ONAY",

                "portalStatusText" : "Incorrect phone information",

                "portalStatus" : 1,

                "errorMessage" : "The phone number must be entered correctly."

            }

        ]

    }

    "message"null

}

Failed

{

    "succeed"false,

    "data"null,

    "message""Error Message"

}

 

Querying the Result of Multiple Message Sending

GUID of String data type was coming as a result of Multiple Message Submission. Now we will query the transaction result using this GUID.

  Metod Access Information

//Access Method (Post)

//Test Environment: https://iysapitest.mysoft.com.tr/api/IYSConsent/ConsentBatchStatus

Parameters When Submitting a Request

Request Parametreleri

Model Name

Model Type

Description

brandCode

String

Brand Code

transctionGuid

String

Returned GUID After Successful Multiple Message Delivery

Incoming Response Parameters (Multiple Result Returning List Model)

With the success of this method, the result is returned on the basis of the transctionGuid obtained. This method updates the main information on each batch as it is processed. These situations can always be controlled.

Response Parameters (Single Result Model)

Model Name

Model Type

Description

transctionGuid

String

Returning GUID After Successful Multiple Message Delivery

batchStatus

Integer

Indicates at what stage the multiple message delivery process is
(1-Bekliyor, 2-İşleniyor, 3-İşlendi, 4-İşlenirken Hata)

batchStatusText

String

Text equivalent of numbers from batchStatus field

recordCount

Integer

Refers to the number of records transferred.

insertedRecordCount

Integer

Number of records imported successfully

updatedRecordCount

Integer

Number of records updating old records during transfer

errorRecordCount

Integer

is the number of records transferred incorrectly

isUsedBeforeRecordCount

Integer

is the number of records previously transferred and not updated

Sample Request and Response

Request (POST)

//{Mysoft IYS Api Address}/api/IYSConsent/ConsentBatchStatus

 

{

     "brandCode"  "6665554",
     "transctionGuid""638bfa83-c188-47a3-81e6-4aef718d27c5"

}

 

Response

Successful

{

    "succeed" true ,

    "data": {

        "transctionGuid" : "638bfa83-c188-47a3-81e6-4aef718d27c5",

        "batchStatus" : 1,

        "batchStatusText" : "Bekliyor",

        "recordCount" : 4,

        "insertedRecordCount" : 1,

        "updatedRecordCount" : 1,

        "errorRecordCount" : 1,

        "isUsedBeforeRecordCount" : 1

    },

    "message" null

} 

Failed

{

    "succeed" false ,

    "data" null ,

    "message""Error Message"

}



Querying the Status of Multiple Message Sending

We will query the status of multiple posts according to the GUID information returned in the String data type as a result of the Multiple Message Submission operation. We will have 4 query types on these transactions.

These Methods;

1.      Successful Records

2.      Incorrect Records

3.      Updated Records

4.      Unprocessed Records

In addition, we have one more method in which the IYS sending status of adding multiple messages is checked. This method also returns the sending status to IYS.

Bu Metod;

1.      Send Inquiry to Multiple IYS

 

Successful Records

It is the method in which the records that are successfully saved to the MYSOFT system as a result of the collective api call are listed. Successfully processed records are returned.

Method Access Information

//Access Method (Post)

//Test Environment: https://iysapitest.mysoft.com.tr/api/IYSConsent/ConsentBatchStatusSuccess

Parameters When Submitting a Request

Request Parameters

Model Name

Model Type

Description

brandCode

String

Brand Code

transctionGuid

String

Returning GUID After Successful Multiple Message Delivery


Incoming Response Parameters (Multiple Result Returning Model)

Successfully processed records are returned.

Response Parameters (List)

Model Name

Model Type

Description

recipient

String

It is the phone number or e-mail information of the citizen registered in the system.

recipientType

String (ENUM)

 ("BIREYSEL", "TACIR"). It is the information showing the status of the merchant.

type

String (ENUM)

("ARAMA", "MESAJ", "EPOSTA") It is the communication channel allowed by the citizen.

consentDate

String (date-time)

It is the date that the citizen determines the communication permit status.
Sample Format (2018-02-10 09:30:00)

source

String (Enum)

 ("HS_FIZIKSEL_ORTAM", "HS_ISLAK_IMZA", "HS_WEB", "HS_CAGRI_MERKEZI", "HS_SOSYAL_MEDYA", "HS_EPOSTA", "HS_MESAJ", "HS_MOBIL", "HS_EORTAM", "HS_ETKINLIK", "HS_2015", "HS_ATM")

status

String (Enum)

 ("ONAY", "RET") Shows the citizen's permit status.

retailerCode

Integer (Nullable) (int?)

It is the İYS number assigned individually by the İYS to the dealer that mediates the permit.

retailerAccess

Integer Generic List (List<int>) 

It shows the list of IMS numbers assigned individually by the IYS to the dealers with permission access.

 

Sample Request and Response

Request  (Post)

//{Mysoft IYS Api Address}/api/IYSConsent/ConsentBatchStatusSuccess

 

{

     "brandCode"  "6665554",
     "transctionGuid""638bfa83-c188-47a3-81e6-4aef718d27c5"

}

 

Response

Successful

{

    "succeed"true,

    "data": [

        {

            "recipient": "+905555555555",

            "recipientType": "BIREYSEL",

            "type": "MESAJ",

            "consentDate": "2018-02-10 09:30:00",

            "source": "HS_FIZIKSEL_ORTAM",

            "status": "ONAY",

            "retailerCode": 1553855,

            "retailerAccess": {5556665665656988595556656565568998855599}

        },

        {

            "recipient": "eposta@mail.com",

            "recipientType": "BIREYSEL",

            "type": "MESAJ",

            "consentDate": "2018-02-10 09:30:00",

            "source": "HS_FIZIKSEL_ORTAM",

            "status": "ONAY",

            "retailerCode": 1553855,

            "retailerAccess": {5556665665656988595556656565568998855599}

        }

    ],

    "message"null

}

 

Failed

{

    "succeed"false,

    "data"null,

    "message""Error Message"

}


 

Incorrect Records

It is the method in which erroneous records are listed as a result of a batch api call. Erroneous records and error messages are returned.

Method Access Information

//Access Method (Post)

//Test Environment: {Mysoft Api Adresi}/api/IYSConsent/ConsentBatchStatusError

Parameters When Submitting a Request

Request Parameters

Model Name

Model Type

Description

brandCode

String

Brand Code

transctionGuid

String

Returning GUID After Successful Multiple Message Delivery

Incoming Response Parameters (Multiple Result Returning Model)

The list of erroneous records returns and the 'errorMessage' field above the records in the returned list returns a message indicating why that record is incorrect.

Response Parameters (Listed)

Model Name

Model Type

Description

recipient

String

It is the phone number or e-mail information of the citizen registered in the system.

recipientType

String (ENUM)

 ("BIREYSEL", "TACIR"). It is the information showing the status of the merchant.

type

String (ENUM)

("ARAMA", "MESAJ", "EPOSTA") It is the communication channel allowed by the citizen.

consentDate

String (date-time)

It is the date that the citizen determines the communication permit status.
Sample Format (2018-02-10 09:30:00)

source

String (Enum)

 ("HS_FIZIKSEL_ORTAM", "HS_ISLAK_IMZA", "HS_WEB", "HS_CAGRI_MERKEZI", "HS_SOSYAL_MEDYA", "HS_EPOSTA", "HS_MESAJ", "HS_MOBIL", "HS_EORTAM", "HS_ETKINLIK", "HS_2015", "HS_ATM")

status

String (Enum)

 ("ONAY", "RET") Shows the citizen's permit status.

retailerCode

Integer (Nullable) (int?)

It is the İYS number assigned individually by the İYS to the dealer that mediates the permit.

retailerAccess

Integer Generic List (List<int>) 

It shows the list of IMS numbers assigned individually by the IYS to the dealers with permission access.

errorMessage

String

kaydın neden hatalı olduğunu belirten mesaj döndürür.

 

Sample Request and Response

Request  (Post)

//{Mysoft IYS Api Address}/api/IYSConsent/ConsentBatchStatusError

 

{

     "brandCode"  "6665554",
     "transctionGuid""638bfa83-c188-47a3-81e6-4aef718d27c5"

}

Response

Successful

{

    "succeed"true,

    "data": [

        {

            "recipient""+905555555555",

            "recipientType""BIREYSEL",

            "type""MESAJ",

            "consentDate""2018-02-10 09:30:00",

            "source""HS_FIZIKSEL_ORTAM",

            "status""ONAY",

            "retailerCode"1553855,

            "retailerAccess": {5556665665656988595556656565568998855599},

            "errorMessage" : "Telefon numarası hatalı"

        },

        {

            "recipient""eposta@mail.com",

            "recipientType""BIREYSEL",

            "type""MESAJ",

            "consentDate""2018-02-10 09:30:00",

            "source""HS_FIZIKSEL_ORTAM",

            "status""ONAY",

            "retailerCode"1553855,

            "retailerAccess": {5556665665656988595556656565568998855599},

            "errorMessage" : "Mail adresi hatalı"

        }

    ],

    "message"null

}

 

Failed

{

    "succeed"false,

    "data"null,

    "message""Error Message"

}


Updated Records

It is the method where the records updated as a result of the api call made collectively are listed. In this method, the state of the records before the update process is returned.

Method Access Information

//Access Method (Post)

//Test Environment: {Mysoft Api Adresi}/api/IYSConsent/ConsentBatchStatusUpdated

Parameters When Submitting a Request

Request Parameters

Model Name

Model Type

Description

brandCode

String

Brand Code

transctionGuid

String

Returning GUID After Successful Multiple Message Delivery

Incoming Response Parameters (Multiple Result Returning Model)

The list of updated records returns.

Response Parameters (Listed)

Model Name

Model Type

Description

recipient

String

It is the phone number or e-mail information of the citizen registered in the system.

recipientType

String (ENUM)

 ("BIREYSEL", "TACIR"). It is the information showing the status of the merchant.

type

String (ENUM)

("ARAMA", "MESAJ", "EPOSTA") It is the communication channel allowed by the citizen.

consentDate

String (date-time)

It is the date that the citizen determines the communication permit status.
Sample Format (2018-02-10 09:30:00)

source

String (Enum)

 ("HS_FIZIKSEL_ORTAM", "HS_ISLAK_IMZA", "HS_WEB", "HS_CAGRI_MERKEZI", "HS_SOSYAL_MEDYA", "HS_EPOSTA", "HS_MESAJ", "HS_MOBIL", "HS_EORTAM", "HS_ETKINLIK", "HS_2015", "HS_ATM")

status

String (Enum)

 ("ONAY", "RET") Shows the citizen's permit status.

retailerCode

Integer (Nullable) (int?)

It is the İYS number assigned individually by the İYS to the dealer that mediates the permission.

retailerAccess

Integer Generic List (List<int>) 

It shows the list of IYS numbers assigned individually by the IYS to the dealers with permission access.

errorMessage

String

 

 

Sample Request and Response

Request  (Post)

//{Mysoft IYS Api Address}/api/IYSConsent/ConsentBatchStatusUpdated

 

{

     "brandCode"  "6665554",
     "transctionGuid""638bfa83-c188-47a3-81e6-4aef718d27c5"

}

Response

Successful

{

    "succeed"true,

    "data": [

        {

            "recipient""+905555555555",

            "recipientType""BIREYSEL",

            "type""MESAJ",

            "consentDate""2018-02-10 09:30:00",

            "source""HS_FIZIKSEL_ORTAM",

            "status""ONAY",

            "retailerCode"null,

            "retailerAccess": null

        },

        {

            "recipient""eposta@mail.com",

            "recipientType""BIREYSEL",

            "type""MESAJ",

            "consentDate""2018-02-10 09:30:00",

            "source""HS_FIZIKSEL_ORTAM",

            "status""ONAY",

            "retailerCode"1553855,

            "retailerAccess": {5556665665656988595556656565568998855599}

        }

    ],

    "message"null

}

 

Failed

{

    "succeed"false,

    "data"null,

    "message""Error Message"

}

 

Unprocessed Records

It is the method in which records that have been processed previously and not processed on as a result of a batch api call are listed.

Method Access Information

//Access Method (Post)

//Test Environment: {Mysoft Api Adresi}/api/IYSConsent/ConsentBatchStatusIsUsedBefore

Parameters When Submitting a Request

Request Parameters

Model Name

Model Type

Description

brandCode

String

Brand Code

transctionGuid

String

Returning GUID After Successful Multiple Message Delivery

Incoming Response Parameters (Multiple Result Returning Model)

A list of previously processed records that are not suitable for changes is returned.

Response Parameters (Revenue In List)

Model Name

Model Type

Description

recipient

String

It is the phone number or e-mail information of the citizen registered in the system.

recipientType

String (ENUM)

 ("BIREYSEL", "TACIR"). It is the information showing the status of the merchant.

type

String (ENUM)

("ARAMA", "MESAJ", "EPOSTA") It is the communication channel allowed by the citizen.

consentDate

String (date-time)

It is the date that the citizen determines the communication permit status.
Sample Format (2018-02-10 09:30:00)

source

String (Enum)

 ("HS_FIZIKSEL_ORTAM", "HS_ISLAK_IMZA", "HS_WEB", "HS_CAGRI_MERKEZI", "HS_SOSYAL_MEDYA", "HS_EPOSTA", "HS_MESAJ", "HS_MOBIL", "HS_EORTAM", "HS_ETKINLIK", "HS_2015", "HS_ATM")

status

String (Enum)

 ("ONAY", "RET") Shows the citizen's permit status.

retailerCode

Integer (Nullable) (int?)

It is the İYS number assigned individually by the İYS to the dealer that mediates the permit.

retailerAccess

Integer Generic List (List<int>) 

It shows the list of IMS numbers assigned individually by the IYS to the dealers with permission access.

errorMessage

String

Returns the error message

 

Sample Request and Response

Request  (Post)

//{Mysoft IYS Api Address}/api/IYSConsent/ConsentBatchStatusIsUsedBefore

 

{

     "brandCode"  "6665554",
     "transctionGuid""638bfa83-c188-47a3-81e6-4aef718d27c5"

}

Response

Successful

{

    "succeed"true,

    "data": [

        {

            "recipient""+905555555555",

            "recipientType""BIREYSEL",

            "type""MESAJ",

            "consentDate""2018-02-10 09:30:00",

            "source""HS_FIZIKSEL_ORTAM",

            "status""ONAY",

            "retailerCode"null,

            "retailerAccess": null

        },

        {

            "recipient""eposta@mail.com",

            "recipientType""BIREYSEL",

            "type""MESAJ",

            "consentDate""2018-02-10 09:30:00",

            "source""HS_FIZIKSEL_ORTAM",

            "status""ONAY",

            "retailerCode"1553855,

            "retailerAccess": {5556665665656988595556656565568998855599}

        }

    ],

    "message"null

}

 

Failed

{

    "succeed"false,

    "data"null,

    "message""Error Message"

}

 

Send Inquiry to Multiple IYS

It is the method in which the records sent to the IYS and query status are listed, which are successfully saved to the MYSOFT system as a result of the collective api call.

Method Access Information

//Access Method (Post)

//Test Environment: {Mysoft Api Adresi}/api/IYSConsent/ConsentBatchSendIYSStatus

Parameters When Submitting a Request

Request Parameters

Model Name

Model Type

Description

brandCode

String

Brand Code

transctionGuid

String

Returning GUID After Successful Multiple Message Delivery

Incoming Response Parameters (Multiple Result Returning Model)

Records and their status are returned. iysSendStatus: 15-IYS'ye gönderiliyor,11-IYS'ye gönderildi,13-IYS' den cevap bekleniyor,18-IYS kaydı başarısız

Response Parameters (Listed)

Model Name

Model Type

Description

recipient

String

It is the phone number or e-mail information of the citizen registered in the system.

recipientType

String (ENUM)

 ("BIREYSEL", "TACIR"). It is the information showing the status of the merchant.

type

String (ENUM)

("ARAMA", "MESAJ", "EPOSTA") It is the communication channel allowed by the citizen.

consentDate

String (date-time)

It is the date that the citizen determines the communication permit status.
Sample Format (2018-02-10 09:30:00)

source

String (Enum)

 ("HS_FIZIKSEL_ORTAM", "HS_ISLAK_IMZA", "HS_WEB", "HS_CAGRI_MERKEZI", "HS_SOSYAL_MEDYA", "HS_EPOSTA", "HS_MESAJ", "HS_MOBIL", "HS_EORTAM", "HS_ETKINLIK", "HS_2015", "HS_ATM")

status

String (Enum)

 ("ONAY", "RET") Shows the citizen's permit status.

retailerCode

Integer (Nullable) (int?)

It is the İYS number assigned individually by the İYS to the dealer that mediates the permit.

retailerAccess

Integer Generic List (List<int>) 

It shows the list of IMS numbers assigned individually by the IYS to the dealers with permission access.

errorMessage

String

Error messages from IYS are returned.

iysSendStatus

int

iysSendStatus: System values ​​used for sending to IYS system. Refers to the status of the registration on Mysoft Portal.

Değerler : 15-IYS'ye gönderiliyor,11-IYS'ye gönderildi,13-IYS' den cevap bekleniyor,18-IYS kaydı başarısız

iysSendStatusText

string

It is the text equivalent of the iysSendStatus field.

Values: 15-IYS'ye gönderiliyor,11-IYS'ye gönderildi,13-IYS' den cevap bekleniyor,18-IYS kaydı başarısız

iysCreationDate

String (date-time)

The time of occurrence of the record sent to IYS system in IYS. The format is (2018-02-10 09:30:00).

iysTransactionId

string

It is the unique key of the record sent to the IYS system.

isSendAllData

bool

It is the parameter that returns the success and failure status of all records belonging to TransactionGuid. If this returns true, all records return their last state. If false, only records that can be passed to IYS return their final state.

 

Sample Request and Response

Request  (Post)

//{Mysoft IYS Api Address}/api/IYSConsent/ConsentBatchSendIYSStatus

 

{

     "brandCode"  "6665554",
     "transctionGuid""638bfa83-c188-47a3-81e6-4aef718d27c5"

}

Response

Successful

{

    "succeed"true,

    "data": [

        {

            "recipient""+905555555555",

            "recipientType""BIREYSEL",

            "type""MESAJ",

            "consentDate""2018-02-10 09:30:00",

            "source""HS_FIZIKSEL_ORTAM",

            "status""ONAY",

            "retailerCode"null,

            "retailerAccess": null,

            "errorMessage": null,

            "iysSendStatus": 11,

            "iysSendStatustext": "IYS’ye Gönderildi." ,

            "iysCreationDate":"2020-01-01 09:30:00",

            "iysTransactionId":"162cc11223344debc34dfe84ed",

        },

    ],

    "message"null

}

 

Failed

{

    "succeed"false,

    "data"null,

    "message""Error Message"

}

 

Status Inquiry With Recipient Information

It is the method that checks the status of the recipient information in the Mysoft system.

Method Access Information

//Access Method (Post)

//Test Environment: {Mysoft Api Adresi}/api/IYSConsent/RecipientStatus

Parameters When Submitting a Request

Request Parameters

Model Name

Model Type

Description

brandCode

String

Brand Code

Brand parameter is not required. If not filled in, information on all brands of the service provider is checked.

recipient

String

It is the recipient information. Mail or Phone information. Controls in the registration process are carried out within this area.

Incoming Response Parameters (Multiple Result Returning Model)

Records and their status are returned. iysSendStatus: 15-IYS'ye gönderiliyor,11-IYS'ye gönderildi,13-IYS' den cevap bekleniyor,18-IYS kaydı başarısız

Response Parameters (Listed)

Model Name

Model Type

Description

brandCode

String

It is brand information.

recipient

String

It is the phone number or e-mail information of the citizen registered in the system.

recipientType

String (ENUM)

 ("BIREYSEL", "TACIR"). It is the information showing the status of the merchant.

type

String (ENUM)

("ARAMA", "MESAJ", "EPOSTA") It is the communication channel allowed by the citizen.

consentDate

String (date-time)

It is the date that the citizen determines the communication permit status.
Sample Format (2018-02-10 09:30:00)

source

String (Enum)

 ("HS_FIZIKSEL_ORTAM", "HS_ISLAK_IMZA", "HS_WEB", "HS_CAGRI_MERKEZI", "HS_SOSYAL_MEDYA", "HS_EPOSTA", "HS_MESAJ", "HS_MOBIL", "HS_EORTAM", "HS_ETKINLIK", "HS_2015", "HS_ATM")

status

String (Enum)

 ("ONAY", "RET") Shows the citizen's permit status.

retailerCode

Integer (Nullable) (int?)

It is the İYS number assigned individually by the İYS to the dealer that mediates the permit.

retailerAccess

Integer Generic List (List<int>) 

It shows the list of IMS numbers assigned individually by the IYS to the dealers with permission access.

errorMessage

String

Error messages from IYS are returned.

iysSendStatus

int

iysSendStatus: System values ​​used for sending to IYS system. Refers to the status of the registration on Mysoft Portal.

Values: 15-IYS'ye gönderiliyor,11-IYS'ye gönderildi,13-IYS' den cevap bekleniyor,18-IYS kaydı başarısız

iysSendStatusText

string

It is the text equivalent of the iysSendStatus field.

Values: 15-IYS'ye gönderiliyor,11-IYS'ye gönderildi,13-IYS' den cevap bekleniyor,18-IYS kaydı başarısız

iysCreationDate

String (date-time)

The time of occurrence of the record sent to IYS system in IYS. The format is (2018-02-10 09:30:00).

iysTransactionId

string

It is the unique key of the record sent to the IYS system.

Sample Request and Response

Request  (Post)

//{Mysoft IYS Api Address}/api/IYSConsent/RecipientStatus

 

{

     "brandCode"  "606202",
     "recipient""mail@example.com"

}

Response


Successful

{

    "succeed"true,

    "data": [

        {

            "brandCode""606202",

            "recipient""+905555555555",

            "recipientType""BIREYSEL",

            "type""MESAJ",

            "consentDate""2018-02-10 09:30:00",

            "source""HS_FIZIKSEL_ORTAM",

            "status""ONAY",

            "retailerCode"null,

            "retailerAccess": null,

            "errorMessage": null,

            "iysSendStatus": 11,

            "iysSendStatustext": "IYS’ye Gönderildi." ,

            "iysCreationDate":"2020-01-01 09:30:00",

            "iysTransactionId":"162cc11223344debc34dfe84ed",

        },

    ],

    "message"null

}

 

Failed

{

    "succeed"false,

    "data"null,

    "message""Error Message"

}

 

Retrospective Records Querying

It is the method by which the historical records are queried by filtering according to the parameters passed to the call.

Method Access Information

//Access Method (Post)

//Test Environment: https://iysapitest.mysoft.com.tr/api/IYSConsent/ConsentQuery

 

Parameters When Submitting a Request

Request Parameters

Model Name

Model Type

Description

brandCode

String

Brand Code

afterValue

Integer

Since there is a limit of 10,000 records per call, it specifies the starting record number of the record to capture all data in 10 thousand pieces. It does not need to be specified in the call where the first 10 thousand are requested. In the first request, it returns 10 thousand data and returns afterValue. According to this return value, it defines the record number from which records will be called in subsequent requests.

sendDate

String (date-time)

Sending date. Sample Format (2018-02-10 09:30:00)

consentDate

String (date-time)

Beginning of the citizen's communication permission date range.. Sample Format (2018-02-10 09:30:00)

iysCreationDate

String (date-time)

Time of occurrence of the record sent to IYS system in IYS. The format is (2018-02-10 09:30:00).

type

String (ENUM) Liste

("ARAMA", "MESAJ", "EPOSTA") It is the communication channel allowed by the citizen.

recipientType

String (ENUM) Liste

("BIREYSEL", "TACIR"). It is the information showing the status of the merchant.

source

String (ENUM) Liste

("HS_FIZIKSEL_ORTAM", "HS_ISLAK_IMZA", "HS_WEB", "HS_CAGRI_MERKEZI", "HS_SOSYAL_MEDYA", "HS_EPOSTA", "HS_MESAJ", "HS_MOBIL", "HS_EORTAM", "HS_ETKINLIK", "HS_2015", "HS_ATM","IYS_3338","IYS_CM", "IYS_WEB", "IYS_MOBIL", "IYS_KISA_LINK")

status

String (ENUM) List

("ONAY", "RET") Shows the citizen's permit status.

limit

Integer

Sets the result limit per request. The maximum can be 10000.

sendDateEnd

String (date-time)

Mysoft IYS submission deadline, Sample Format (2018-02-10 09:30:00)

consentDateEnd

String (date-time)

Citizen's communication permission date range end, Sample Format (2018-02-10 09:30:00)

iysCreationDateEnd

String (date-time)

IYS record date range end, Sample Format (2018-02-10 09:30:00)

mainSource

String (ENUM) List

("HS","IYS") If HS is selected, all HS sources are selected. If IYS is selected, all IYS resources are selected.


Incoming (Response) Parameters   (Single Result Returning Model)

Response Parameters

Model Name

Model Type

Description

brandCode

String

Brand Code

afterValue

String

Since there is a limit of 10,000 records per call, it specifies the starting record number of the record to capture all data in 10 thousand pieces.

recordCount

Integer

Indicates the number of records

consentData

ConsentDataResponseModel List

ConsentDataResponseModel in Generic List


ConsentDataResponseModel

ConsentDataResponseModel

Parametre Adı

Parametre Tipi

Açıklama

consentDate

String (date-time)

It is the date that the citizen determines the communication permit status. If the buyer type is TACIR, it does not have to be added. Sample Format (2018-02-10 09:30:00)

recipient

String

The citizen's phone number or e-mail information registered in the system. Email addresses cannot be longer than 284 characters long and phone numbers cannot exceed 15 characters. The phone number must be in the format of +905813334455. ([+] [country code] [area code] [local phone number]) (+905555555555)

recipientType

String (ENUM)

It only takes 2 values. ("BIREYSEL", "TACIR"). Information showing the status of the merchant. (Default value: BIREYSEL)

status

String (Enum)

Takes only 2 values ("ONAY", "RET") Shows the citizen's permit status.

type

String (ENUM)

It only takes 3 values. ("ARAMA", "MESAJ", "EPOSTA") It is the communication channel allowed by the citizen.

source

String (ENUM)

It only takes 12 values. ("HS_FIZIKSEL_ORTAM", "HS_ISLAK_IMZA", "HS_WEB", "HS_CAGRI_MERKEZI", "HS_SOSYAL_MEDYA", "HS_EPOSTA", "HS_MESAJ", "HS_MOBIL", "HS_EORTAM", "HS_ETKINLIK", "HS_2015", "HS_ATM")

retailerCode

Integer (Nullable) (int?)

It is the İYS number assigned individually by the İYS to the dealer that mediates the permit.

retailerAccess

Integer Generic List (List<int>)

It shows the list of İYS numbers assigned individually by the İYS to the dealers with permission access.

explanation

String

Description

errorMessage

String

Error Message

errorCode

String

Error Code

iysSendStatus

Integer

Sending status

iysSendStatusText

String

Sending status text

iysCreationDate

String (date-time)

Time of occurrence of the record sent to IYS system in IYS. The format is (2018-02-10 09:30:00).

iysTransactionId

string

It is the unique key of the record sent to the IYS system.


Sample Request and Response

Request (POST)

{

    "brandCode""555556655",

    "afterValue"null//This field is left blank when the first 10 thousand is drawn and then filled.

    "sendDate""2018-02-10 09:30:00",

    "consentDate""2018-02-10 09:30:00",

    "iysCreationDate""2018-02-10 09:30:00",

    "type": ["ARAMA""MESAJ""EPOSTA"],

    "recipientType": ["BIREYSEL""TACIR"],

    "source": ["HS_MESAJ""HS_MOBIL""HS_EORTAM""HS_ETKINLIK""HS_2015""HS_ATM"],

    "status": ["ONAY""RET"],

    "limit"10000

    "sendDateEnd""2018-02-10 09:30:00",

    "consentDateEnd""2018-02-10 09:30:00",

    "iysCreationDateEnd""2018-02-10 09:30:00",

    "mainSource": ["HS""IYS"]

}

 


Response Successful

{

    "succeed"true,

    "data": {

        "brandCode": "555556655",

        "afterValue": 10000//If there are more than 10 thousand records, it gives the registration number to start with the next request.

        "recordCount": 100,

        "consentData": [

            {

                "recipient": "+905555555555",    

                "recipientType": "BIREYSEL",    

                "type": "MESAJ",    

                "consentDate": "2018-02-10 09:30:00",    

                "source": "HS_FIZIKSEL_ORTAM",    

                "status": "ONAY",    

                "retailerCode": 1553855,    

                "retailerAccess": {5556665665656988595556656565568998855599}    

            },    

            {   

                "recipient": "eposta@mail.com",  

                "recipientType": "BIREYSEL"

                "type": "MESAJ",  

                "consentDate": "2018-02-10 09:30:00",    

                "source": "HS_FIZIKSEL_ORTAM",    

                "status": "ONAY",   

                "retailerCode": 1553855,   

                "retailerAccess": {5556665665656988595556656565568998855599}   

            }

        ]

    },

    "message"null

}

 


Failed

{

    "succeed"false,

    "data"null,

    "message""Hata Mesajı"

}

 

WebHook Services

WebHook services are API methods that trigger systems integrated by Mysoft. It ensures that the changes detected in the Webhook IYS system are instantly transferred to the relevant company services. Webhook API Information must be registered on Mysoft Portal. This process can be performed on the Portal, on the Company information screen, in the IYS tab. The process to be done here is Post. In this process, the data to be posted will be posted as json. It is expected to generate an exception in case of error. The return value will not be checked. If the call ends with 200, the transaction will be counted as successful. The object to be posted for this process is WebhookConsentModel. Model properties are listed below.

WebhookConsentModel Post Object

Post Parameters

Model Name

Model Type

Description

webHookKey

String

Refers to the private area requested for calls. It is the private key value entered while saving webhook information on the portal. It has been added to block calls.

brandCode

String

Brand Code

consentData

ConsentDataModel

Added Data Model (Singular)

ConsentDataModel

ConsentDataModel

Parameter Name

Parameter Type

Description

recipient

String

It is the phone number or e-mail information of the citizen registered in the system. Email addresses cannot be longer than 284 characters long and phone numbers cannot exceed 15 characters.
The phone number must be in the format of +905813334455.
([+][country code][area code][local phone number]) (+905555555555)

recipientType

String (ENUM)

It only takes 2 values. ("BIREYSEL", "TACIR"). It is the information showing the status of the merchant. (Default value: BIREYSEL)

type

String (ENUM)

It only takes 3 values. ("ARAMA", "MESAJ", "EPOSTA") It is the communication channel allowed by the citizen.

consentDate

String (date-time)

It is the date that the citizen determines the communication permit status. If the buyer type is TACIR, it does not have to be added. Sample Format (2018-02-10 09:30:00)

source

String (Enum)

It only takes 12 values. ("HS_FIZIKSEL_ORTAM", "HS_ISLAK_IMZA", "HS_WEB", "HS_CAGRI_MERKEZI", "HS_SOSYAL_MEDYA", "HS_EPOSTA", "HS_MESAJ", "HS_MOBIL", "HS_EORTAM", "HS_ETKINLIK", "HS_2015", "HS_ATM","IYS_3338","IYS_CM", "IYS_WEB", "IYS_MOBIL", "IYS_KISA_LINK")

 

status

String (Enum)

Takes only 2 values ("ONAY", "RET")
Shows the citizen's permit status.

retailerCode

Integer (Nullable) (int?)

It is the IYS number assigned individually by the IYS to the dealer that mediates the permission.

retailerAccess

Integer Generic List (List<int>) 

It shows the list of IYS numbers assigned individually by the IYS to the dealers with permission access.