Миграция API edna Enterprise

После перехода на платформу edna вы можете продолжать использовать API нашей старой платформы edna Enterprise. Методы старого API, которые вы используете для интеграции, продолжают работать, но при этом API доступно по новому адресу.

Платформа edna поддерживает следующие методы старого API:

  • Отправка сообщений
  • Отправка HSM-сообщений 
  • Получение статуса доставки сообщений
  • Получение списка подключенных подписей
  • Callback-методы получения статуса сообщений и входящих сообщений

Полный перечень и описание всех методов доступно в этом разделе.

Включите новую версию интеграции в дату, когда ваши каналы будут переключены в платформу edna.

Также с начала 2023 г. поддержка старых методов API будет остановлена, поэтому мы рекомендуем вам заранее прейти на целевую схему интеграции. Подробнее в документации по API платформы edna

В этой статье мы рассмотрим два варианта миграции API:

  • Если вы сами (то есть пользователь Платформы edna) являетесь конечным пользователем API старой платформы;
  • Если вы работаете через агента (то есть вендора), который в свою очередь использует API старой платформы.

Что делать конечному пользователю

В новую платформу мы перенесли:

  • API-ключ, который действовал на старой платформе;
  • URL вашего сервера для callback-функций получения статуса отправленного сообщения и/или получения входящего сообщения (если этот адрес был настроен).

Подготовьте обновление вашей интеграции. Вызовы необходимо выполнять по адресу https://app.edna.ru/api/old/<метод>. Например:

Раньше: запрос отправки чат-сообщения на старой платформеhttps://im.edna.ru/api/imOutMessage
Теперь: запрос отправки чат-сообщения на платформе ednahttps://app.edna.ru/api/old/imOutMessage

Что делать агенту (вендору)

Если интеграцию с платформой edna вам помогал настроить сторонний агент, воспользуйтесь рекомендациями из этого раздела.

  1. Сообщите вашему вендору, что вы переключаетесь на новую платформу, уточните срок перехода.
  2. Далее передайте менеджеру компании, занимающейся интеграцией, следующую инструкцию для обновления:
    1. На новую платформу перенесены API-ключ, который действовал на старой платформе и URL сервера для callback-функций получения статуса отправленного сообщения и/или получения входящего сообщения (если этот адрес был настроен).
    2. Подготовьте обновление интеграции:
      1. Теперь при вызове метода необходимо использовать новый API-ключ, который вы получили от клиента.
      2. Вызовы необходимо выполнять по адресу https://app.edna.ru/api/old/<метод>. Например:
Раньше: запрос отправки чат-сообщения на старой платформеhttps://im.edna.ru/api/imOutMessage
Теперь: запрос отправки чат-сообщения на платформе ednahttps://app.edna.ru/api/old/imOutMessage

Как протестировать работу методов

Вы можете протестировать работу интеграции до перехода на новую платформу. Для этого в edna вам доступен наш тестовый канал WhatsApp.

Если вы — вендор и не имеете доступа к личному кабинету edna, свяжитесь с клиентом для прохождения тестирования вместе.
  1. Добавьте номер телефона, на который вы хотите получить сообщение, в личный кабинет edna в раздел Интеграция > Тестирование.
  2. Напишите любое сообщение с вашего номера на тестовый канал WhatsApp. Ссылку на него вы также найдете в разделе Интеграция > Тестирование.
  3. Выполните запрос для отправки сообщения по адресу https://app.edna.ru/api/old/imOutMessage:
{
    "id": "1",
    "subject": "ednatest8_WA_номертенанты",
    "address": "test_phone_number",
    "imType": "whatsapp",
    "contentType": "text",
    "text": "Hello! Welcome to our platform."
}

где:

  • номертенанты — Номер личного кабинета edna. Чтобы узнать номер, зайдите в Профиль > Профиль компании, на вкладке Лицензии найдите раздел Активные подписи.  Там будет надпись Testing subject for tenant ХХХ. ХХХ — это и есть номер тенанты.
  • test_phone_number — Номер телефона, который вы добавили для тестирования.

Вы также можете протестировать разные варианты отправки HSM-сообщений, используя способ выше.

Выполняйте запросы метода по адресу https://app.edna.ru/api/old/imOutHSM.

Текстовое сообщение

{
    "id": "1",
    "subject": "ednatest8_WA_номертенанты",
    "address": "test_phone_number",
    "imType": "whatsapp",
    "contentType": "text",
   "text": "Hello! Welcome to our platform."
}

Текстовое сообщение с заголовком и подписью

{
    "id": "2",
    "subject": "ednatest8_WA_номертенанты",
    "address": "test_phone_number",
    "imType": "whatsapp",
    "contentType": "text",
    "text": "Hello! Welcome to our platform.",
    "header": {
            "text": "Greetings"
    },
    "footer": {
           "text": "Have a nice day"
    }
}

Текстовое сообщение с чат-кнопками

{
    "id": "3",
    "subject": "ednatest8_WA_номертенанты",
    "address": "test_phone_number",
    "imType": "whatsapp",
    "contentType": "text",
    "text": "Hello! Welcome to our platform. Have you already tried it?",
    "keyboard": {
        "row": {
            "buttons": [
            {
                "text": "Yes",
                "buttonType": "QUICK_REPLY",
                "payload": "1"
            },
            {
                "text": "No",
                "buttonType": "QUICK_REPLY",
                "payload": "2"
            }
            ]
        }
    }
}

Текстовое сообщение с кнопкой-ссылкой

{
    "id": "4",
    "subject": "ednatest8_WA_номертенанты",
    "address": "test_phone_number",
    "imType": "whatsapp",
    "contentType": "text",
    "text": "Hello! Welcome to our platform. Follow the link bellow to read manuals:",
    "keyboard": {
        "row": {
            "buttons": [
            {
                "text": "Manual",
                "buttonType": "URL",
                "url": "https://docs.edna.io/"
            }
            ]
        }
    }
}
Начало работы в edna для тех, кто мигрирует с edna Enterprise