Talbiet għall-Ismijiet Alpha

Rotot API biex jinħolqu u jelenkaw ismijiet Alpha (ismijiet tan-negozju verifikati użati bħala mittenti tal-messaġġ).

1. Oħloq Isem Alfa tal-Organizzazzjoni

Din it-talba POST tintuża biex jinħoloq Isem Alfa ġdid assoċjat ma’ organizzazzjoni. It-talba teħtieġ ċavetta ta’ awtorizzazzjoni ta’ organizzazzjoni fl-intestaturi.

Talba

• URL: https://restapi.smsbat.com/organizations/alpha_name
• Metodu: POST
• Headers:
  • “Aċċetta: applikazzjoni/json”.
  • X-Authorization-Key: {organization_token} (Maħluq fit-taqsima tal-Profil tal-Utent).

Korp:

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

Parametri tal-Korp:

1. “isem” (String): L-Isem Alpha propost.
   • Rekwiżit: It-tul għandu jkun inqas minn 12-il karattru.
2. “companyCode” (String): Il-kodiċi tar-reġistrazzjoni tal-kumpanija assoċjat mal-Alphaname (ERPOU/IPN għall-Ukrajna).

Tweġibiet Possibbli:

• 200 OK: Isem Alpha intbagħat b’suċċess għall-moderazzjoni/ħolqien.
• 400 Talba Ħażina: Żball ta’ validazzjoni (eż., l-isem huwa twil wisq).
• 401 Mhux Awtorizzat: ‘X-Awtorizzazzjoni-Key’ invalida jew nieqsa.

---

2. Iġbed AlphaName Lista

Jiġbor lista aġġornata ta’ Ismijiet Alpha, inklużi l-istatus ta’ moderazzjoni attwali tagħhom.

Talba

• URL: https://restapi.smsbat.com/organizations/alpha_name/list
• Metodu: IKOLLOK
• Headers:
  • X-Awtorizzazzjoni-Key: {organization_token}

Tweġiba (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"
    }
]

Status tal-Ismijiet Alpha (‘statusCode’):

• “PA” - Pendenti Approvazzjoni
• “A” - Approvat
• D - Naqas