MATLAB WEB API

English | Русский

Description 🇬🇧

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

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:

• Bing Maps - Mapping service
• Data.gov.ru - Open data of Russian Federation
• Flickr - Photohosting
• HeadHunter - Russian recruiting service
• ip-api.com - IP geolocation
• NetSuite - CRM system
• OpenWeatherMap - Weather service
• REST Countries - Countries information
• uinames.com - Random names generator
• VK - Russian social network
• YouTube - Video hosting
• MPS - MATLAB Production Server
• TelegramBot - Telegram Bot API

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:

eval(webread('https://exponenta.ru/install/web'))

2nd approach (install from scratch)

• Download MATLAB-WEB-API.mltbx
• Open it

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 - фотохостинг
• HeadHunter - сервис поиска работы
• ip-api.com - геолокация оп IP
• NetSuite - CRM-система
• OpenWeatherMap - сервис погоды
• REST Countries - информация о странах
• uinames.com - генератор случайных имён
• VK - российская социальная сеть
• YouTube - видео-хостинг
• MPS - MATLAB Production Server
• TelegramBot - Telegram Bot API

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

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

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

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

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

eval(webread('https://exponenta.ru/install/web'))

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

• Скачайте MATLAB-WEB-API.mltbx
• Откройте его

Способ 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