3️⃣ Анализ API-документации

Идём по плану. Работу с верхнеуровневым проектированием архитектуры завершили. Теперь нужно изучать API.

В работе с интеграционным проектом, важнейшим этапом является анализ API-документации партнеров: СДЭК, Возовоз и Деловые линии. Системному аналитику важно понимание их API.

Попытка описывать функциональность системы с интеграциями без детального изучения API-документации может привести к рискам в процессе разработки:

✖️ Нет нужных методов, чтобы реализовать получение или запись данных во внешней системе.

✖️ Нет нужных данных: метод для реализации функциональности есть, но данных для нашей системы недостаточно и нужно проявить изобретательность, чтобы всё получилось, либо идти на переговоры к партнерам.

✖️ Обрабатываете не все ошибки и исключительные ситуации, которые являются нормальными в системе партнера, но для вас никогда не были реализованы.

✖️ Пытаетесь придумать сценарий интеграции сами, хотя в документации партнера есть рекомендации, которые сэкономили бы вам дни работы.

✖️ Проблемы с авторизацией и аутентификацией запросов: не учли, что нужны дополнительные системные или пользовательские авторизации и потеряли логику авторизации запросов.


С каждым риском можно будет разобраться позже. Но скорее всего это уже будут придуманные “костыли” на ходу, вместо заранее продуманного плана действия.

Такая работа похожа на марафон без подготовки: ты ни разу не бегал 42 км, а теперь после 6 км пытаешься придумать на ходу как пробежать ещё 36, и чтобы сердце не отказало сейчас 🏃‍♀️💀❤️‍🩹

🔌 Use Case с брокером: Завершение зарядки авто с оплатой по привязанной карте 🔌


👉 Предусловия:
▫️ Пользователь завершает зарядку электромобиля на станции.
▫️ В его аккаунте уже привязана банковская карта.
▫️ Нужно корректно завершить сессию, рассчитать оплату, списать деньги и уведомить пользователя.


👉 Use Case — старт зарядки






#АрхитектураGA

Сомнительная зона комфорта 🤨

Есть у нас аналитиков такой период в карьере, который можно назвать зоной комфорта с сомнениями. Ты во всем разобрался, хорошо знаешь, что тебя ждёт в текущем проекте. Получая очередную задачу, понимаешь что делать с ней.

И, казалось бы, это успех! Тебя любит команда, чувствуешь свою важность и, главное, уверенность! В чем проблема? Где подвох?

Долго наслаждаться этим состоянием зоны комфорта не получается. Становится скучно. В IT это распространенная практика для всех специалистов.

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

И вот, на первых собеседованиях в компании, которые интересны, спрашивают больше - за пределами того, что делал на текущем месте работы. А переходить в другое место с похожими условиями и задачами не хочется. Зачем? Хорошая команда и комфортное место и так есть.

Это в вас проснулся синдром самозванца и "и так сойдёт". В эти моменты, когда что-то сразу не получается, важно не опускать руки, иметь поддержку от близких и наставников, строить собственный план роста, и делать всё возможное для его реализации. Любые ошибки должны становиться мотивацией. Да, придётся приложить усилия, но это того стоит!

Ребята, вы поймите, пока зону комфорта не покинете, ничего в жизни не поменяется.

Я вижу много успешных примеров среди своих учеников, кто в процессе обучения улучшает свою позицию: повышение в должности, ЗП, новая ответственность, смена компании. Это говорит о том, что постановка целей и работа над их реализацией приводят к результатам.

Не запирайте себя в одной клетке, если вас тормозит страх или ощущение внутреннего самозванца. Нет ничего невозможного. И если вы знаете что хотите, то вы это обязательно получите! 🌟

Коллеги, ставьте 🔥 у кого случался синдром самозванца. Делитесь в комментариях как справлялись?

Анализ API-документации СДЭК - продолжение 👇

4️⃣ Рекомендации по использованию. Примеры сценариев использования.
Пыталась найти, но не получилось.
Посмотрела информацию в разделах “Описание сервиса” и “Регистрация заказа”. Явных предложений по последовательным сценариям использования нет. Все методы описаны независимо. Это ок.


5️⃣ Общие требования к обработке ошибок. Коды ответов.
Нашла два полезных раздела: “Список ошибок интеграции” и “Список предупреждений интеграции”.
Посмотрела, зафиксировала. Вернусь к этим разделам на этапе детальной проработки требований - описания детализированных Use Case для разработчиков бэкенда.


6️⃣ Список методов, необходимых для реализации интеграционных сценариев, и документацию по ним.
На этапе знакомства с документацией сильно вчитываться не надо. Главное понять, что методов для реализации бизнес-процессов текущего проекта достаточно.

Все методы API описаны в разделах с “Регистрация заказа” и далее.
Нужные методы к анализу:
- Калькулятор. Расчет по коду тарифа
- Калькулятор. Расчет по доступным тарифам

Полезное по справочникам, надо посмотреть как у нас будем вести:
- Cписок почтовых индексов города
- Список офисов
- Список регионов
- Список населенных пунктов

Если будем делать заказы:
- Регистрация заказа
- Информация о заказе
- Изменение заказа
- Удаление заказа

Другие методы буду смотреть по мере необходимости, но ключевое пока для себя выделила и знаю как действовать.


Просматриваю в общем структуру запросов-ответов, названия методов, выстраиваю примерный сценарий работы в голове. Всё. Пазл сложился! Можно переходить к анализу следующих документов, а после этого приступать к описанию интеграционных Use Cases, когда у нас будет полная картина по интеграциям с каждым из сервисов доставки!


P.S. Важный момент на который обратила внимание, но не написала: поддержано версионирования API! Это стандартное и коллеги молодцы. Но важно помнить, что версионирование через URL-запросов надо будет в конфигурацию интеграции со СДЭК заложить.

Согласитесь, было бы славно: выложил на вакансию и тебе сразу 5 классных офферов пришло. Или захотел свежий круассан, а тебе коллега уже несёт вместе с кофе 😄

Звучит, как сценарий к фильму «Брюс Всемогущий» или как какой-то сюжет из параллельной Вселенной, который может только сниться.

И нет, и да! Когда мы по-настоящему чего-то хотим, о чём-то искренне мечтаем, то планета сразу начинает крутиться вокруг нас 😏

Уверена, каждый из вас с этим сталкивался хоть раз в жизни: внезапно появляются нужные знакомства, книги, статьи, и даже реклама в директ любезно подмигивает как раз по нужной теме. А главное — появляются время и силы!

Да, дорога к своим желаниям процесс креативный и интересный. Никогда не знаешь, а что или кто может поспособствовать осуществлению желаемого 🙌


Коллеги, не хочу брать на себя многое 😁, но возможно, для кого-то тоже побуду в роли «того самого знака» на пути к цели.

Сегодня 11.12.23. Пост запланирован на 3:44 дня по Мск.
111223344 - это сигнал, знак вселенной! 🔮

Может это тот самый момент волшебства? И через год вы будете вспоминать про этот сигнал с улыбкой, смехом и новыми достижениями? Звучит как возможность! 🪄


Завтра будет крутой вебинар по интеграциям:

📝 Интеграции: как создавать задачи на разработчиков
📅 12 декабря, 19:00 МСК
🔗 ЗАРЕГИСТРИРОВАТЬСЯ


По плану:

1️⃣ Познакомимся с задачей на интеграции.
2️⃣ Попрактикуемся выделять важные части API-документации.
3️⃣ Опишем архитектуру проекта в С4 и определим порядок вызова методов и обработки данных.
4️⃣ Создадим интеграционный Use Case и разберем моменты, где могут быть ошибки из-за неучтенных требований.
5️⃣ Будем ставить задачи на разработку БД, Backend и Frontend.


Увидимся онлайн 1212231900 Мск! ❤️

Hello!

Что сделала перед вебинаром:

1. Подготовила Confluence, Jira и Draw.io.
2. Проверила API через Postman.
3. Запросила у вендора (внешняя система, к которой интеграция) тестовые доступы.
4. Подготовила новогодние бонусы, которые будут доступны только в прямом эфире.
5. Заготовила фишки с plantUML.
6. Подготовила презентацию и себя, чтобы всё прошло круто!

Коллеги, сегодня подключаемся с компьютера, будем активно работать, общаться в чате, и нужна будет ваша помощь! Заранее зарегистрируйтесь в Postman, его тоже посмотрим.

Увидимся онлайн, поставьте напоминалки и будильники на 19:00 😏💜

❗️Уже через 3 часа❗️

Практический вебинар с Екатериной Ананьевой!

📹 Интеграции: как создавать задачи на разработчиков
⏰ 19:00 - 21:00 Мск

Ссылку на прямой эфир пришлем в канал за 15 минут до начала.

😂👍👍❤️👌😅😊😊😍😘

❗️До начала 15 минут❗️

📹 Интеграции: как создавать задачи на разработчиков

Переходите по ссылке: https://pruffme.com/webinar/?id=1962d840af72edb1c0ce08495c906878 и начинаем!

Вебинары GetAnalyst стали продуманными историями 🙌

Я рассказываю про проект в течение нескольких недель в канале, а затем мы собираемся онлайн и я продолжаю практику с ним вживую. Это как книга, после которой ты идёшь смотреть продолжение в виде фильма и отрабатывать навыки.


Коллеги, все кто вчера был онлайн, еще раз настоятельно рекомендую погрузиться в контекст проекта GetDelivery, теории, и прочитать всё до сегодняшнего поста и далее, чтобы наша практика стала еще более полезной и структурированной в вашей памяти.


Это был один из тех вебинаров, где мне удалось показать много технического:

⚡️Проанализировать API-документацию с вашей помощью.
⚡️Поработать с консолью разработчика.
⚡️Показать основы работы с Postman и дать рекомендации по первым шагам, когда он нужен.
⚡️Погрузиться в архитектуру системы и обсудить возможные решения.
⚡️Поговорить про нефункциональные требования и нагрузку на систему.
⚡️Показать связки для использования ChatGPT в работе.
⚡️Детализировать интеграционный сценарий и показать его пример в Confluence.
⚡️Объяснить подвох интеграций: как за одной функцией могут скрываться 10-ки задач на разработку, которые мы выявили.


Про тайминг практики: 3.5 часа мы провели онлайн. Казахстан, Новосибирск и другие города правее Москвы, все те, у кого под конец вебинара 2+ ночи и вы всё ещё в эфире - вау!!! 🥰

Вебинар был посвящен старту практической программы по проектированию интеграций. Сейчас у команды проекта уже идет предобучение, а первый вебинар у нас с ними пройдёт 19 декабря. В течение 10 недель мы онлайн будем разбирать один большой проект. Это практика, благодаря которой можно глубоко погрузиться во все этапы проектирования интеграций систем, чтобы потом использовать полученный опыт в своей работе.


Сейчас команда готовит повтор вебинара. Ждем сообщения от команды GetAnalyst здесь, на почте и на странице регистрации.


Друзья, спасибо, что вы есть ❤️ Ваша поддержка и активное участие вдохновляют на постоянный рост!

А чего бы не взять, раз адекватный 😀

Сомневаешься в себе - значит ты плохой специалист?

Ох, как мне раньше было знакомо это чувство тревоги 😐Да что уж говорить, мне и сейчас иногда тревожно, что может не хватает опыта, знаний или уверенности в себе.

Когда постоянно работаешь, буквально просыпаешь с телефоном в руке и засыпаешь ноутбуком в обнимку, а всё равно кажется, что чего-то не хватает, что-то упустила и т.д.
Знаю, как многие катаются на таких аттракционах в обнимку с внутренним самозванцем.

Лучшее средство перестать гулять по этому парку “развлечений” - это опора на реальные достижения 👌 Например, изучил plantUML, попробовал сделать несколько схем сам, и принес новый инструмент в свою работу - показал в деле. Или освоил подход к работе с задачами на интеграции в GetAnalyst, осознал, как это можно перенести в свою текущую работу и с помощью новых навыков расти в карьере - применяешь и видишь реальные изменения.

Это моя формула успеха:
1. Чувствую необходимость актуализации знаний ->
2. Получаю их через сообщества, профессиональные мероприятия, книги и обучения ->
3. Внедряю в практику сразу ->
4. Вижу любой результат, корректирую при необходимости, а затем радуюсь новым достижениям.

Так я поддерживаю внутреннее ощущение уверенности. Когда понимаешь, что владеешь нужными навыками и регулярно занимаешься самоактуализацией, то выдыхаешь и перестаёшь тревожиться. Ты всегда знаешь, что будешь востребован ☝️

Давайте своей самооценке передохнуть, а сами в этот момент получайте новый опыт и знания.

При этом помните - у каждого из нас свой путь, свой темп, свои достижения — маленькие и большие 😉

P.S. Завтра продолжим работать с GetDelivery. По плану детализированный Use Case и маппинг данных.

🔺 Пример интеграционного Use Case 🔺

На практическом вебинаре сделала черновик. Сейчас привела в порядок основную часть и показала как может выглядеть описание интеграционного сценария.

Из важного:

🔹 Use Case для пользователей и их взаимодействия с мобильными и веб-приложениями (Frontend) пишется отдельно. Это Use Case на Backend, при том достаточно сложный по реализации.
Дополнила статью схемой архитектуры для наглядности. Теперь вы точно поняли, зачем она системному аналитику (без неё сложно воспринимать Use Case, надо много воображать).

🔹В рамках этого Use Case надо сделать 2 API метода и настроить работу очереди. Еще и с БД поработать. Описание Use Case - корневая статья в Confluence, под которую можно сделать отдельные статьи - постановки задач на API методы, БД, очередь и т.д.

🔹Это задача не первая в процессе работы с интеграцией. На практическом вебинаре рассказала, что до неё еще конфигурации, справочники, решение по архитектуре финальное, API протестировать… Много работы 🙂

Не стала постами оформлять. Забирайте выгрузку из Confluence - пересылайте себе это сообщение, чтобы сохранить в закладки 🚀

Прежде чем писать детализированный интеграционный Use Case, настоятельно рекомендую протестировать API, чтобы понять как он работает и убедиться в том, что документация соответствует реальности.

Для интеграции со СДЭК мы будем использовать API, опубликованный на их официальном сайте. Тестировать его можно через Postman:
1. Все запросы POST.
2. Тип данных JSON.

Проверить нужно только те методы, которые необходимы для работы нашей системы:
- авторизация,
- работа со справочниками,
- расчет стоимости доставки,
- далее, при необходимости, разобраться как работать с заказами.
Первые шаги мы уже делали на практическом вебинаре.


Где бы ни была сделана API-документация системы, я всегда проверяю ее. Мне всегда важно увидеть как реально работает API. И это же рекомендую делать и вам, чтобы лучше разобраться с данными внешней системы, с которой мы интегрируемся, и с процессами в ней.

К этому посту я прикрепляю вам видео-урок по работе с Postman. Смотреть с открытым Postman и практиковаться обязательно! 😉

Продолжаем рубрику с историями наших студентов #студентыGetAnalyst.

Мы работаем с обратной связью, благодаря которой стараемся делать внутри GetAnalyst всё лучшее. По возможности стараемся пообщаться с каждым учеником, чтобы узнать как дела, результаты и собрать предложения по улучшению. И я всегда горжусь результатами 🥰

Сегодня рассказываем про достижения Лауры — студентки программы «Интеграции систем».

Лаура — менеджер проектов.

Ранее в GetAnalyst она уже проходила программу «Системный аналитик: с нуля до опыта работы» и другие воркшопы. На обучение по интеграциям в прошлый поток она решила пойти, чтобы углубить знания для новой работы.

После курса девушка поделилась впечатлениями:
«Курс оказался очень объёмный, с большим количеством полезной информации.
Понравилось, что курс был «технический», нацеленный на большое количество практики.

Тема освещается детально, работа ведётся углублённо, а не поверхностно (если сравнивать с другими курсами). Удалось лучше понять и освоить Postman.

Порадовало, что спикеры глубоко погружены в тему, поскольку работают с тем, о чём говорят.

Ещё всегда приятно, что обучение проходит в небольшой группе, и уделяется время на разбор вопросов».

Недавно Лаура нам рассказала, что перешла на новую работу с лучшими условиями и повышением в должности: «Там как раз много задач на интеграции — в этом курс очень помог».

Желаем Лауре реализовать полученные знания в работе и дальше развиваться в профессии! 💛