MATLAB framework for work with WEB services (supports OAuth 1.0/2.0)
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
+WEB
data
doc
examples
.gitignore
MATLAB-WEB-API.mltbx
MATLAB-WEB-API.prj
MATLABWEBAPIDev.m
MATLABWEBAPIExtender.m
MATLABWEBAPIUpdater.m
README.md
ToolboxConfig.xml
cover.png
dev_on.m
info.xml

README.md

MATLAB WEB API

MATLAB WEB API Cover

English | Русский

Description 🇬🇧

Framework for building handy WEB APIs to work with any WEB services from MATLAB

Follow project on MathWorks File Exchange

Key features:

  • Set of methods, templates and examples for quick creation of WEB API to work with any WEB service from MATLAB
  • Library to work with WEB requests
  • Support of OAuth 1.0, OAuth 2.0 access protocols

At the moment, the work with services is partially done:

Welcome aboard! Together we will add more of services API and improve the existing.

How to install

For use only

1st approach (install from scratch)

In MATLAB execute:

r = webread('https://api.github.com/repos/ETMC-Exponenta/MATLAB-WEB-API/releases/latest');
websave(r.assets.name, r.assets.browser_download_url);
open(r.assets.name)

2nd approach (install from scratch)

3rd approach (update installed)

Check the current and latest versions:

WEB.API.Ver

Update to the latest version:

WEB.API.Update

For development

  • Install Git
  • Learn how to use Git
  • In OS command line execute:
git clone https://github.com/ETMC-Exponenta/MATLAB-WEB-API.git

Where to start

Start with examples:

WEB.API.Examples

Note: to work with some WEB Services you need to register and get access keys. See particular Service Developer documentation

Examine documentation:

WEB.API.Doc

Описание 🇷🇺

Фреймворк для создания удобных WEB API для работы с любыми WEB-сервисами из MATLAB

Страница проекта на MathWorks File Exchange

Ключевые особенности:

  • Набор методов, шаблонов и примеров для быстрого создания WEB API для работы с любым WEB-сервисом из MATLAB
  • Библиотека для работы с WEB-запросами
  • Поддержка протоколов авторизации OAuth 1.0, OAuth 2.0

На данный момент частично реализована работа с сервисами:

  • Bing Maps - картографический сервис
  • Data.gov.ru - открытые данные России
  • Flickr - фотохостинг OAuth logo
  • HeadHunter - сервис поиска работы
  • ip-api.com - геолокация оп IP
  • NetSuite - CRM-система OAuth logo
  • OpenWeatherMap - сервис погоды
  • REST Countries - информация о странах
  • uinames.com - генератор случайных имён
  • VK - российская социальная сеть OAuth 2.0 logo

Присоединяйтесь! Вместе мы добавим больше сервисов и улучшим работу с имеющимися.

Как установить

Только для использования

Способ 1 (установка с нуля)

В MATLAB выполните:

r = webread('https://api.github.com/repos/ETMC-Exponenta/MATLAB-WEB-API/releases/latest');
websave(r.assets.name, r.assets.browser_download_url);
open(r.assets.name)

Способ 2 (установка с нуля)

Способ 3 (обновление)

Узнать текущую и последнюю версии:

WEB.API.Ver

Обновление до последней версии:

WEB.API.Update

Для разработчиков

  • Установите Git
  • Изучите основы работы с Git
  • В командной строке ОС выполните:
git clone https://github.com/ETMC-Exponenta/MATLAB-WEB-API.git

С чего начать

Начните с изучения примеров:

WEB.API.Examples

Обратите внимание: для работы с некоторыми сервисами вам потребуется зарегистрироваться и получить ключи доступа. Изучайте документацию для разработчиков соответствующих сервисов

Изучите документацию:

WEB.API.Doc