Если вы не слышали ранее об Открытом Пакете Интеграций (что вполне вероятно), то небольшая вводная часть ниже, под катом. Для тех, кто уже знаком с ОПИ, данный раздел можно пропустить.
Открытый Пакет Интеграций (ОПИ) - это open-source набор методов для простой и быстрой интеграции с различными популярными API. Он состоит из аналогичных по функционалу 1С-расширения (CFE), OS-пакета и программы для Windows и Linux, которые предоставляют готовые функции для работы с целым набором различных онлайн-сервисов.
- ОПИ бесплатен и имеет открытый исходный код на GitHub. Вы всегда можете получить последнюю версию библиотеки на странице репозитория, а подписавшись - узнавать о выходе обновлений. Все релизы сопровождаются статьями на Инфостарт и разделами единой документации. На Инфостарт вы можете подписаться уже хоть сейчас, а про документацию я расскажу далее.
- Удобная единая документация. Она расположена на сайте opi.neocities.org и содержит в себе всю информацию, необходимую для работы: инструкции по предварительным действиям для начала интеграции, описания всех методов с параметрами и возвращаемыми значениями, примеры кода и т.д. Каждый API имеет там свой раздел.
- Простая установка. ОПИ распространяется во множестве вариантах: как XML файлы расширения, как EDT проект расширения, как файл расширения формата .cfe (версия 1С 8.3.9), как файл пакета для OneScript и еще в целом наборе пакетов и файлов для Windows и Linux. Из этого набора вы всегда сможете выбрать тот способ установки, который лучше подойдет для вашей конкретной задачи
На момент последнего обновления данной статьи, доступны следующие API:
Наиболее актуальную информацию можно посмотреть в репозитории или на вводной странице документации.
CDEK - один из самых известных операторов доставки в России и странах СНГ. Многие магазины и фирмы пользуются его услугами для доставки своих грузов, заказов и документов
И у него есть API для управления всем этим. В данном обновлении ОПИ была реализована работа со следующими его функциями:
- Общий функционал
- Получение токена
- Получение чеков оплат на дату
- Получение реестров платежей на дату
- Получение переводов наложенных платежей на дату
- Получение списка офисов
- Работа с заказами
- Создание заказа
- Изменение заказа
- Удаление заказа
- Получение информации о заказе
- Оформление клиентских возвратов
- Создание отказов
- Формирование и получение квитанций в формате PDF
- Формирование и получение штрихкодов в формате PDF
- Создание и получение преалертов
- Получение статуса внесения паспортных данных для международных заказов
- Получение чека зказа
- Управление доставкой
- Получение доступных интервалов доставки
- Создание заявки на вызов курьера
- Получение информации о заявке на вызов курьера
- Удаление заявки на вызов курьера
- Фиксация договоренности о доставке
- Получение информации о договоренности о доставке
Описание всех методов, как всегда, есть в документации. Сейчас же отмечу еще несколько моментов по работе с API CDEK и библиотекой ОПИ в целом
Тестовый контур
У CDEK API есть тестовый контур и авторизационные данные для него:
Это позволяет начать разработку и отладить процесс интеграции без захламления рабочего аккаунта и даже до заключения договора вовсе. Подробнее можно узнать в начале документации самого CDEK
Что касается методов, реализованных в ОПИ, то использование тестового или рабочего контура определяется там в каждой функции при помощи параметра ТестовыйAPI
Обновление документации
К этому обновлению были сделаны некоторые улучшения для документации в целом
Во-первых, более понятным стал блок примера вызова для CLI (если что, ОПИ выходит не только как расширение для 1С, но и как приложение для командной строки). Раньше этот блок генерировался кое-как на основе данных 1Сных тестов, но к этому релизу был закончен полный набор тестов отдельно для CLI приложения. Поэтому данные в примерах вызовов теперь реальные и проверенные, также, как и в примерах кода для 1С
Во-вторых, добавилась новая колонка в таблицу описания функции - обязательность параметра. Она отображает, является параметр обязательным или нет
Ну еще есть набор незначительных визуальных изменений: добавлена более четкая обводка блоков кода, блоку CLI включена нормальная подсветка и прочие мелочи. Посмотреть это все можно по данной ссылке
Ну а пока все! Скачать Открытый пакет интеграций можно по ссылкам ниже
Спасибо за внимание!
Также не забывайте ставить звездочку этому и другим проектам, если они вам понравилась! Проектам это помогает в развитии, а вам - в отслеживании новостей о выходе новых версий
Репозиторий ОПИ: github.com/Bayselonarrend/OpenIntegrations
Последний релиз: github.com/Bayselonarrend/OpenIntegrations/releases/latest
Другие статьи про Открытый пакет интеграций на Инфостарт:
Открытый пакет интеграций для популярных API: Telegram, VK, Viber, Twitter
Открытый пакет интеграций для OneScript
Мой GitHub: https://gitub.com/Bayselonarrend OpenYellow: https://openyellow.org Лицензия MIT: https://mit-license.org
