Alfa-nimipyyntöjä

API-reitit alfa-nimien luomiseen ja luetteloimiseen (viestin lähettäjänä käytetyt vahvistetut yritysten nimet).

1. Luo organisaation alfanimi

Tätä POST-pyyntöä käytetään luomaan uusi alfa-nimi, joka liittyy organisaatioon. Pyyntö vaatii organisaation valtuutusavaimen otsikoissa.

Pyyntö

• URL-osoite: https://restapi.smsbat.com/organizations/alpha_name
• Menetelmä: POST
• Otsikot:
  • “Hyväksy: sovellus/json”.
  • X-Authorization-Key: {organisation_token} (Luotu Käyttäjäprofiili-osiossa).

Runko:

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

Runkoparametrit:

1. “nimi” (merkkijono): ehdotettu alfa-nimi.
   • Edellytys: Pituuden tulee olla alle 12 merkkiä.
2. “companyCode” (merkkijono): Alfanimeen liittyvä yrityksen rekisteröintikoodi (ERPOU/IPN Ukrainalle).

Mahdolliset vastaukset:

• 200 OK: Alfa-nimi lähetettiin onnistuneesti valvottavaksi/luodattavaksi.
• 400 Virheellinen pyyntö: Vahvistusvirhe (esim. nimi on liian pitkä).
• 401 Luvaton: Virheellinen X-Authorization-Key tai puuttuu.

---

2. Hae AlphaName List

Hakee ajantasaisen luettelon alfanimistä, mukaan lukien niiden nykyiset valvontatilat.

Pyyntö

• URL-osoite: https://restapi.smsbat.com/organizations/alpha_name/list
• Menetelmä: HANKI
• Otsikot:
  • “X-Authorization-Key: {organisation_token}”.

Vastaus (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-nimien tilat (statusCode):

• “PA” - Odottaa hyväksyntää
• “A” - Hyväksytty
• “D” - Hylätty