Ալֆա անունների հարցումներ

API-ի երթուղիներ՝ ստեղծելու և ցուցակագրելու ալֆա անունները (ստուգված բիզնեսի անունները, որոնք օգտագործվում են որպես հաղորդագրություն ուղարկող):

1. Ստեղծեք կազմակերպության ալֆա անունը

Այս POST հարցումն օգտագործվում է կազմակերպության հետ կապված նոր Ալֆա Անուն ստեղծելու համար: Հարցումը պահանջում է կազմակերպության թույլտվության բանալի վերնագրերում:

խնդրանք - URL: «https://restapi.smsbat.com/organizations/alpha_name» - Մեթոդ: ՓՈՍՏ - ** Վերնագրեր: ** - «Ընդունել. դիմում/json»: - «X-Authorization-Key. {organization_token}» (Ստեղծված է Օգտվողի պրոֆիլի բաժնում):

** Մարմինը:**

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

** Մարմնի պարամետրերը: ** 1. «անուն» (տող). Առաջարկվող ալֆա անունը: - Պահանջ. Երկարությունը պետք է լինի 12 նիշից պակաս: 2. «companyCode» (string). Ընկերության գրանցման կոդը, որը կապված է Alphaname-ի հետ (ERPOU/IPN Ուկրաինայի համար):

** Հնարավոր պատասխաններ. - 200 OK: Ալֆա Անունը հաջողությամբ ուղարկվեց մոդերավորման/ստեղծման: - 400 Վատ հարցում. Վավերացման սխալ (օրինակ՝ անունը չափազանց երկար է): - 401 Չլիազորված. Անվավեր է կամ բացակայում է «X-Authorization-Key»:

2. Ստացեք AlphaName ցուցակը

Առբերում է ալֆա անունների արդի ցուցակը, ներառյալ նրանց ընթացիկ մոդերատորության կարգավիճակները:

խնդրանք - URL: «https://restapi.smsbat.com/organizations/alpha_name/list» - Մեթոդ. GET - ** Վերնագրեր: ** - «X-Authorization-Key. {organization_token}»:

Պատասխան (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"
    }
]

Ալֆա Անվան կարգավիճակներ (statusCode): - «PA» - Սպասվում է հաստատմանը - «Ա» - Հաստատված է - «Դ» - մերժել է