Лёгкое программирование под Autodesk Vault. Часть 2

Что такое API?

Интерфейс программирования приложений (иногда интерфейс прикладного программирования) (англ. application programming interface, API [эй-пи-ай]) — набор готовых классов, процедур, функций, структур и констант, предоставляемых приложением (библиотекой, сервисом) для использования во внешних программных продуктах. Используется программистами для написания всевозможных приложений. […]API определяет функциональность, которую предоставляет программа (модуль, библиотека), при этом API позволяет абстрагироваться от того, как именно эта функциональность реализована.

Если программу (модуль, библиотеку) рассматривать как чёрный ящик, то API — это множество «ручек», которые доступны пользователю данного ящика, и которые он может вертеть и дёргать. (Wikipedia)

Где он расположен?

Web Services API состоит из Autodesk.Connectivity.WebServices DLL.  Эта библиотека позволяет вам взаимодействовать с сервером.

Существует несколько редакций Vault, но API один для всех. Как с этим жить теперь?

В процессе взаимодействия с сервером вы можете использовать только те службы, которые поддерживает сервер. В 2014 версии Vault есть 3 редакции:

• Basic
• Workgroup
• Professional

Представленная ниже диаграмма наглядно описывает распределение функционала по версиям.

Где:

2 – полный функционал

1 – функционал ограничен

0 – недоступно

Разработан Каталог служб API на основании сводных таблиц, который может быть удобен для оперативного поиска подходящих служб.

Что могут службы API?

Практически всё, что могут клиент Vault и ADMS, так как они реализуют идею «dogfooding».

Как использовать API?

1. Вставить ссылку на библиотеку в проект.
2. Осуществлять обращение к серверу, используя методы служб.

Список методов служб для быстрого поиска расположен в Каталоге методов служб Vault API, также сформирован в сводных таблицах.