Mga Kahilingan sa Mga Pangalan ng Alpha
Mga ruta ng API para gumawa at maglista ng mga pangalan ng Alpha (mga na-verify na pangalan ng negosyo na ginamit bilang nagpadala ng mensahe).
1. Lumikha ng Alpha Name ng Organisasyon
Ang kahilingan sa POST na ito ay ginagamit para gumawa ng bagong Alpha Name na nauugnay sa isang organisasyon. Nangangailangan ang kahilingan ng authorization key ng organisasyon sa mga header.
Kahilingan
- URL: https://restapi.smsbat.com/organizations/alpha_name
- Paraan: POST
- Mga Header:
- Tanggapin: application/json
- X-Authorization-Key: {organization_token} (Ginawa sa seksyong User Profile).
Katawan:
Mga Body Parameter:
1. name (String): Ang iminungkahing Alpha Name.
- Kailangan: Dapat mas mababa sa 12 character ang haba.
2. CompanyCode (String): Ang code ng pagpaparehistro ng kumpanya na nauugnay sa Alphaname (ERPOU/IPN para sa Ukraine).
Mga Posibleng Tugon:
- 200 OK: Ang Alpha Name ay matagumpay na naipadala para sa moderation/creation.
- 400 Masamang Kahilingan: Error sa pagpapatunay (hal., masyadong mahaba ang pangalan).
- 401 Hindi awtorisado: Di-wasto o nawawalang X-Authorization-Key.
2. Kunin ang Listahan ng AlphaName
Kinukuha ang isang napapanahon na listahan ng Mga Pangalan ng Alpha, kasama ang kanilang kasalukuyang mga katayuan sa pag-moderate.
Kahilingan
- URL: https://restapi.smsbat.com/organizations/alpha_name/list
- Paraan: GET
- Mga Header:
- X-Authorization-Key: {organization_token}
Tugon (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"
}
]
Mga Katayuan ng Pangalan ng Alpha (statusCode):
- PA - Nakabinbing Pag-apruba
- A - Naaprubahan
- D - Tinanggihan