Žiadosti o mená alfa

API trasy na vytváranie a zoznam názvov Alpha (overené obchodné názvy používané ako odosielateľ správ).

1. Vytvorte alfa názov organizácie

Táto požiadavka POST sa používa na vytvorenie nového názvu alfa priradeného k organizácii. Požiadavka vyžaduje autorizačný kľúč organizácie v hlavičkách.

Žiadosť - URL: https://restapi.smsbat.com/organizations/alpha_name - Spôsob: POST - Hlavičky: - "Prijať: application/json". - X-Authorization-Key: {organization_token} (Vytvorené v sekcii Profil používateľa).

Telo:

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

Parametre tela: 1. „name“ (reťazec): Navrhovaný názov alfa. - Požiadavka: Dĺžka by mala byť menšia ako 12 znakov. 2. "CompanyCode" (reťazec): Registračný kód spoločnosti spojený s Alphaname (ERPOU/IPN pre Ukrajinu).

Možné odpovede: - 200 OK: Alfa meno bolo úspešne odoslané na moderovanie/vytvorenie. - 400 zlá požiadavka: Chyba overenia (napr. názov je príliš dlhý). - 401 Unauthorized: Neplatný alebo chýbajúci kľúč X-Authorization-Key.

---

2. Získajte zoznam názvov alfa

Načíta aktuálny zoznam mien alfa vrátane ich aktuálnych stavov moderovania.

Žiadosť - URL: https://restapi.smsbat.com/organizations/alpha_name/list - Spôsob: GET - Hlavičky: - X-Authorization-Key: {organization_token}

Odpoveď (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"
    }
]

Stavy názvu alfa (statusCode): - "PA" - Čaká na schválenie - "A" - Schválené - "D" - Odmietnuté