Alfa vardų užklausos

API maršrutai alfa pavadinimams kurti ir išvardyti (patvirtinti verslo pavadinimai naudojami kaip pranešimo siuntėjas).

1. Sukurkite organizacijos alfa pavadinimą

Ši POST užklausa naudojama naujam alfa pavadinimui, susietam su organizacija, sukurti. Užklausai reikalingas organizacijos prieigos raktas antraštėse.

Prašymas – URL: https://restapi.smsbat.com/organizations/alpha_name - Metodas: PAST - Antraštės: - „Priimti: programa/json“. - X-Authorization-Key: {organization_token} (Sukurta skiltyje Vartotojo profilis).

Kūnas:

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

Kėbulo parametrai: 1. Vardas (Eilutė): siūlomas alfa pavadinimas. - Reikalavimas: ilgis turi būti mažesnis nei 12 simbolių. 2. „CompanyCode“ (Eilutė): įmonės registracijos kodas, susietas su raidiniu pavadinimu (ERPOU/IPN Ukrainai).

Galimi atsakymai: - 200 Gerai: Alfa pavadinimas sėkmingai išsiųstas moderuoti / sukurti. - 400 netinkama užklausa: patvirtinimo klaida (pvz., pavadinimas per ilgas). - 401 Neteisėtas: Neteisingas X-Authorization-Key arba jo nėra.

---

2. Gaukite Alfapavadinimų sąrašą

Gauna naujausią alfa vardų sąrašą, įskaitant dabartinę jų moderavimo būseną.

Prašymas - URL: https://restapi.smsbat.com/organizations/alpha_name/list - Metodas: GAUTI - Antraštės: - „X-Authorization-Key: {organization_token}“.

Atsakymas (200 gerai):

[
    {
        "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 vardo būsenos („statusCode“): – „PA“ – laukiama patvirtinimo – „A“ – patvirtinta - "D" - Atmetė