Escrow API

MFCoin Escrow

Escrow предоставляет API-интерфейс для доступа к различной информации сервиса.

Запросы возвращают JSON-ответ, пример:


{
    "status": "success", 
    "data": [ ], 
    "error": ""
}

где status - статус ответа (error или sucess);
data - массив с данными ответа;
error - текст ошибки, если она появилась во время запроса.


Для выполнения некоторых запросов требуется API ключ, который можно найти в личном кабинете, и авторизация.
Сначала выполняется авторизация пользователя через /api/auth_user.php, затем авторизация api_key через /api/auth_api.php, после чего можно выполнять запросы.
Ниже показаны примеры авторизации.


1. Авторизация пользователя (устарело)

  • Тип запроса: POST
  • Шаблон: https://bazar.mfcoin.net/api/auth_user.php
  • Данные в запросе: email - электронная почта, password - пароль.
  • Вернет: по примеру выше.

2. Авторизация api_key

Данный запрос необходим для авторизации вашего API-ключа, чтобы выполнять некоторые другие запросы (см. ниже).
Запрос должен выполнять после авторизации пользователя.

  • Тип запроса: GET
  • Шаблон: https://bazar.mfcoin.net/api/auth_api.php?api_key={API_KEY}
  • Данные в запросе: {API_KEY} - ваш API-ключ из личного кабинета.
  • Пример ответа:

{
    "status": "success", 
    "data": {
        "uid": "2"
    }, 
    "error": ""
}
	

где uid - ваш User ID.


3. Получение данных о пользователе (себе)

Перед данным запросом требуется авторизация.

  • Тип запроса: GET
  • Шаблон: https://bazar.mfcoin.net/api/user.php?method={METHOD}
  • Данные в запросе: {METHOD} - тип заправшиваемых данных, например:
    • getAddress - запрос адреса внутреннего баланса, пример ответа:
      
      {
          "status": "success", 
          "data": {
              "address": "MoXCPebkN2h3mXeV96nrYb6tPnDH2qnB7c"
          }, 
          "error": ""
      }
      			
    • getAddress - данные о балансе: доступный, замороженный, ожидающий подтверждений, пример ответа:
      
      {
          "status": "success", 
          "data": {
              "available": "4.64300000", 
              "frozen": "0.00000000", 
              "awaiting": "0.00000000"
          }, 
          "error": ""
      }
      			

4. Запрос рейтинга произвольного пользователя

  • Тип запроса: GET
  • Шаблон: https://bazar.mfcoin.net/api/rating.php?uid={UID}
  • Также: https://bazar.mfcoin.net/api/rating.php?email={EMAIL}
  • Данные в запросе:
  • {UID} - идентификатор пользователя,
  • {EMAIL} - email пользователя.
  • Пример ответа:
    
    {
        "status": "success", 
        "data": {
            "UR": "5.00", 
            "deals": "4", 
            "done": "2", 
            "volume": "21"
        }, 
        "error": ""
    }
    	

где UR - User Rating - средний рейтинг пользователя по 5 бальноый шкале с округлением до сотых;
deals - всего завершенных сделок (успешных и с возвратом);
done - количество сделок завершенных успешно;
volume - суммарный объем сделок в mfc;


5. Получение данных о предложении

  • Тип запроса: GET
  • Шаблон: https://bazar.mfcoin.net/api/offer.php?oid={oid}
  • Данные в запросе: {oid} - offer id - идентификатор предложения.
  • Пример ответа:
    
    {
        "status": "success", 
        "data": {
            "created": "2017-12-22 22:48:27", 
            "edited": "2017-12-22 22:48:27", 
            "active": "0", 
            "closed": "0", 
            "user": "Sagleft", 
            "title": "Бинокль", 
            "direction": "sell", 
            "pcount": "2", 
            "min": "1", 
            "units": "шт", 
            "price": "1.00000000", 
            "deliveryMethod": "почтой", 
            "deliveryTime": "50", 
            "extras": ""
        }, 
        "error": ""
    }
    	

где created - дата создания предложения (UTC +0);
edited - дата изменения (UTC +0);
active - активно ли предложение (можно ли сейчас по нему создать сделку), значения '0' и '1';
closed - было ли предложение закрыто (после закрытия по нему нельзя открывать сделки), значения '0' и '1';
user - псевдоним автора предложения;
title - название предложения (товара или услуги);
direction - направление предложения, значения 'sell' и 'buy';
pcount - product count - количество товара в резерве предложения;
min - минимальный заказ в пределах одной сделки;
units - единицы измерения количества товара;
price - цена за 1 единицу товара;
deliveryMethod - описание метода доставки товара;
deliveryTime - ожидаемое максимальное время доставки в минутах;
extras - дополнительные сведения;


6. Получение данных о сделке

Требуется авторизация и отношение к сделке.

  • Тип запроса: GET
  • Шаблон: https://bazar.mfcoin.net/api/deal.php?edi={EDI}
  • Данные в запросе: {EDI} - Escrow Deal ID - идентификатор сделки.
  • Пример ответа:
    
    {
        "status": "success", 
        "data": {
            "edi": "1", 
            "oid": "1", 
            "status": "returned", 
            "amount": "1.00000000", 
            "pcount": "1", 
            "isSent": "0", 
            "isReceived": "0", 
            "timeFrom": "2017-12-22 22:57:32", 
            "timeTo": "2017-12-22 23:47:32", 
            "waitTime": "0000-00-00 00:00:00", 
            "disputeTime": "0000-00-00 00:00:00"
        }, 
        "error": ""
    }
    	

где edi - escrow deal id - идентификатор сделки;
oid - offer id - идентификатор предложения;
status - текущий статус сделки (paid, returned, done, wait, dispute, court);
amount - сумма сделки в mfc;
pcount - product count - количество товара в сделке;
isSent - был ли товар отправлен продавцом, значения '0' и '1';
isReceived - был ли товар получен покупателем, значения '0' и '1';
timeFrom - время заключения сделки (UTC +0);
timeTo - время окончания срока ожидания доставки (UTC +0);
waitTime - время, до которого покупатель может открыть спор, если время ожидания доставки вышло (UTC +0);
disputeTime - время, до которого действует спор, а затем будет передан в арбитраж, если спор не будет решен (UTC +0);


7. Запрос информации о новых событиях

Для этого запроса требуется авторизация. Набор массивов с данными о событиях или пустой массив.

  • Тип запроса: GET
  • Шаблон: https://bazar.mfcoin.net/api/events.php
  • Пример ответа:
    
    [
        {
            "type": "chat", 
            "event": {
                "edi": 1, 
                "title": "Computer", 
                "messages": 5
            }
        }, 
        {
            "type": "chat", 
            "event": {
                "edi": 3, 
                "title": "Litecoin", 
                "messages": 10
            }
        }
    ]
    	

где type - тип события:

  • chat - новые сообщения в чате сделки. при этом event:
    • edi - escrow deal id - id сделки,
    • title - заголовок сделки,
    • messages - количество новых сообщений.


7. Получение данных о активных предложениях пользователя

  • Тип запроса: GET
  • Шаблон: https://bazar.mfcoin.net/api/offers.php?uid={UID}
  • Данные в запросе: {UID} - ID пользователя.
  • Пример ответа:
    
    {
        "status": "success", 
        "data": [
            {
                "title": "Карта", 
                "direction": "sell", 
                "pcount": "1", 
                "units": "шт", 
                "deliveryTime": "1620", 
                "created": "2018-04-03 18:06:06", 
                "edited": "2018-04-03 18:06:06", 
                "price": "12", 
                "min": "1", 
                "closed": "0", 
                "im_seed": "SFGOPATtNYv5T688gnr3Ybsp", 
                "im_id": "2", 
                "image": "https://bazar.mfcoin.net/upload/0/o2SFGOPATtNYv5T688gnr3Ybsp.jpg"
            }, 
            {
                "title": "Велосипед", 
                "direction": "sell", 
                "pcount": "1", 
                "units": "шт", 
                "deliveryTime": "180", 
                "created": "2018-04-03 18:06:27", 
                "edited": "2018-04-03 18:06:27", 
                "price": "1200", 
                "min": "1", 
                "closed": "0", 
                "im_seed": "kNVnRZ5OpimQVILXKChJsWVb", 
                "im_id": "3", 
                "image": "https://bazar.mfcoin.net/upload/0/o3kNVnRZ5OpimQVILXKChJsWVb.jpg"
            }, 
            {
                "title": "Смартфон на Windows 7", 
                "direction": "sell", 
                "pcount": "1", 
                "units": "шт", 
                "deliveryTime": "180", 
                "created": "2018-04-03 18:06:56", 
                "edited": "2018-04-03 18:06:56", 
                "price": "5000", 
                "min": "1", 
                "closed": "0", 
                "im_seed": "MD4gmzCJS3GIHKPexzRI3Ncu", 
                "im_id": "4", 
                "image": "https://bazar.mfcoin.net/upload/0/o4MD4gmzCJS3GIHKPexzRI3Ncu.jpg"
            }
        ], 
        "error": ""
    }
    	

где oid - offer id - id предложения;
created - дата создания предложения (UTC +0);
edited - дата изменения (UTC +0);
closed - было ли предложение закрыто (после закрытия по нему нельзя открывать сделки), значения '0' и '1';
title - название предложения (товара или услуги);
direction - направление предложения, значения 'sell' и 'buy';
pcount - product count - количество товара в резерве предложения;
min - минимальный заказ в пределах одной сделки;
units - единицы измерения количества товара;
price - цена за 1 единицу товара;
deliveryTime - ожидаемое максимальное время доставки в минутах;
im_id - id изображения предложения;
im_seed - код изображения (im_id и im_seed используются для построения ссылки к изображению);
image - url изображения предложения;