Alfa nevek kérése

API-útvonalak alfa-nevek létrehozásához és listázásához (üzenetküldőként használt ellenőrzött vállalkozásnevek).

1. Hozzon létre szervezet alfa nevet

Ez a POST-kérelem egy szervezethez társított új alfa név létrehozására szolgál. A kéréshez a fejlécekben egy szervezeti engedélyezési kulcsra van szükség.

Kérés

• URL: https://restapi.smsbat.com/organizations/alpha_name
• Módszer: POST
• Fejlécek:
  • Elfogadás: application/json
  • X-Authorization-Key: {organization_token} (Létrehozva a Felhasználói profil részben).

Test:

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

Testparaméterek:

1. “név” (karakterlánc): A javasolt alfa név.
   • Követelmény: A hossza nem lehet kevesebb, mint 12 karakter.
2. “companyCode” (karakterlánc): Az alfanévhez társított cégregisztrációs kód (ERPOU/IPN Ukrajnában).

Lehetséges válaszok:

• 200 OK: Az alfa név sikeresen elküldve moderálásra/létrehozásra.
• 400 Hibás kérés: Érvényesítési hiba (pl. a név túl hosszú).
• 401 Jogosulatlan: Érvénytelen vagy hiányzó “X-Authorization-Key”.

---

2. Alfanév-lista lekérése

Lekéri az alfa-nevek naprakész listáját, beleértve a jelenlegi moderálási állapotukat.

Kérés

• URL: https://restapi.smsbat.com/organizations/alpha_name/list
• Módszer: GET
• Fejlécek:
  • “X-Authorization-Key: {organization_token}”.

Válasz (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"
    }
]

Alfa névállapotok (statusCode):

• “PA” - Jóváhagyás függőben
• “A” - Jóváhagyva
• “D” - Elutasította