Заявки за Алфа имена (Alpha Names)

API маршрути за създаване и извеждане на списък с Алфа имена (потвърдени имена на бизнеси, използвани като подател на съобщение).

1. Създайте Алфа име за организация

Тази POST заявка се използва за създаване на ново Алфа име (Alpha Name), свързано с организация. Заявката изисква ключ за авторизация на организацията в заглавките (headers).

Заявка - URL: https://restapi.smsbat.com/organizations/alpha_name - Метод: POST - Заглавки (Headers): - Accept: application/json - X-Authorization-Key: {organization_token} (Създава се в раздела Потребителски профил).

Тяло на заявката:

{
  "name": "testName",
  "companyCode": "88888888"
}

Параметри на тялото: 1. name (String): Предложеното Алфа име. - Изискване: Дължината трябва да бъде по-малка от 12 знака. 2. companyCode (String): Регистрационният код на компанията, свързан с Алфа името (ЕИК / БУЛСТАТ за България, ERPOU/IPN за Украйна).

Възможни отговори: - 200 OK: Алфа името беше успешно изпратено за модерация/създаване. - 400 Bad Request: Грешка при валидиране (напр., името е твърде дълго). - 401 Unauthorized: Невалиден или липсващ X-Authorization-Key.

---

2. Извличане на списък с Алфа имена

Извлича актуален списък на Алфа имената, включително текущите им статуси на модериране.

Заявка - URL: https://restapi.smsbat.com/organizations/alpha_name/list - Метод: GET - Заглавки: - X-Authorization-Key: {organization_token}

Отговор (200 OK):

[
    {
        "name": "test1",
        "status": "Pending Approval",
        "statusCode": "PA",
        "statusUpdateDate": "2024-07-24T16:34:40.137432Z"
    },
    {
        "name": "test2",
        "status": "Approved",
        "statusCode": "A",
        "statusUpdateDate": "2024-07-24T15:46:50.494443Z"
    }
]

Статуси на Алфа имена (statusCode): - PA - В очакване на одобрение (Pending Approval) - A - Одобрено (Approved) - D - Отхвърлено (Declined)