Žádosti o jména alfa

Směrování API pro vytváření a seznam názvů alfa (ověřených obchodních názvů používaných jako odesílatel zpráv).

1. Vytvořte alfa název organizace

Tento požadavek POST se používá k vytvoření nového názvu alfa přidruženého k organizaci. Požadavek vyžaduje autorizační klíč organizace v hlavičkách.

Žádost

• URL: https://restapi.smsbat.com/organizations/alpha_name
• Metoda: POST
• Záhlaví:
  • “Přijmout: application/json”.
  • X-Authorization-Key: {organization_token} (Vytvořeno v sekci Profil uživatele).

Tělo:

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

Parametry těla:

1. název (řetězec): Navrhovaný název alfa.
   • Požadavek: Délka by měla být kratší než 12 znaků.
2. “CompanyCode” (řetězec): Registrační kód společnosti spojený s Alphaname (ERPOU/IPN pro Ukrajinu).

Možné odpovědi:

• 200 OK: Jméno alfa bylo úspěšně odesláno k moderování/vytvoření.
• 400 špatný požadavek: Chyba ověření (např. název je příliš dlouhý).
• 401 Unauthorized: Neplatný nebo chybějící „X-Authorization-Key“.

---

2. Načtěte seznam jmen alfa

Načte aktuální seznam jmen alfa, včetně jejich aktuálních stavů moderování.

Žádost

• URL: https://restapi.smsbat.com/organizations/alpha_name/list
• Metoda: GET
• Záhlaví:
  • X-Authorization-Key: {organization_token}

Odpověď (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 - Čeká na schválení
• “A” - Schváleno
• “D” - Odmítnuto