Iarratas ar Ainmneacha Alfa
Bealaí API chun ainmneacha Alfa a chruthú agus a liostú (ainmneacha gnó fíoraithe a úsáidtear mar sheoltóir teachtaireachtaí).
1. Cruthaigh Ainm Alfa Eagraíochta
Úsáidtear an t-iarratas POST seo chun Ainm Alfa nua a chruthú a bhaineann le heagraíocht. Teastaíonn eochair údaraithe eagraíochta sna ceannteidil don iarratas.
Iarratas
- URL: https://restapi.smsbat.com/organizations/alpha_name
- Modh: POST
- Ceanntásca:
- Glac le: iarratas/json
- X-Authorization-Key: {organization_token} * (Cruthaithe sa chuid Próifíl Úsáideora).*
Comhlacht: _CÓD_BLOCK_0__
Paraiméadair an Chorp:
1. ainm (Teaghrán): An Alfa Ainm molta.
- Ceanglas: Ba chóir go mbeadh an fad níos lú ná 12 charachtar.
2. Cod na cuideachta (Teaghrán): Cód clárúcháin na cuideachta a bhaineann leis an Alfaainm (ERPOU/IPN don Úcráin).
Freagraí Féideartha:
- 200 OK: Seoladh Alfa Ainm go rathúil le haghaidh modhnóireachta/cruthaithe.
- 400 Drochiarratas: Earráid bhailíochtaithe (m.sh., tá an t-ainm ró-fhada).
- 401 Neamhúdaraithe: Neamhbhailí nó in easnamh X-Authorization-Key.
2. Faigh Liosta AlfaName
Aisghabhann sé liosta cothrom le dáta d’Ainmneacha Alfa, lena n-áirítear a stádas modhnóireachta reatha.
Iarratas
- URL: https://restapi.smsbat.com/organizations/alpha_name/list
- Modh: FAIGH
- Ceanntásca:
- X-Údarú-Eochair: {organization_token}
Freagra (200 ceart go leor): _CÓD_BLOCK_1__
** Stádais Ainm Alfa (Cód Stádais):**
- PA - Faomhadh ar Feitheamh
- A - Ceadaithe
- D - Diúltaithe