Μετάβαση στο περιεχόμενο

Αιτήματα ονομάτων Alpha

Το API δρομολογεί για τη δημιουργία και τη λίστα ονομάτων Alpha (επαληθευμένα ονόματα επιχειρήσεων που χρησιμοποιούνται ως αποστολέας μηνυμάτων).

1. Δημιουργήστε Όνομα Alpha Οργανισμού

Αυτό το αίτημα POST χρησιμοποιείται για τη δημιουργία ενός νέου ονόματος Alpha που σχετίζεται με έναν οργανισμό. Το αίτημα απαιτεί ένα κλειδί εξουσιοδότησης οργανισμού στις κεφαλίδες.

αίτημα - URL: https://restapi.smsbat.com/organizations/alpha_name - Μέθοδος: ΑΝΑΡΤΗΣΗ - Κεφαλίδες: - «Αποδοχή: εφαρμογή/json». - X-Authorization-Key: {organization_token} (Δημιουργήθηκε στην ενότητα Προφίλ χρήστη).

Σώμα:

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

Παράμετροι σώματος: 1. όνομα (String): Το προτεινόμενο Alpha Name. - Απαίτηση: Το μήκος πρέπει να είναι μικρότερο από 12 χαρακτήρες. 2. «CompanyCode» (String): Ο κωδικός εγγραφής εταιρείας που σχετίζεται με το Alphaname (ERPOU/IPN για την Ουκρανία).

Πιθανές απαντήσεις: - 200 ΟΚ: Το όνομα Alpha στάλθηκε με επιτυχία για εποπτεία/δημιουργία. - 400 Εσφαλμένο αίτημα: Σφάλμα επικύρωσης (π.χ. το όνομα είναι πολύ μεγάλο). - 401 Μη εξουσιοδοτημένο: Μη έγκυρο ή λείπει το "X-Authorization-Key".


2. Λήψη λίστας AlphaName

Ανακτά μια ενημερωμένη λίστα ονομάτων Alpha, συμπεριλαμβανομένων των τρεχουσών καταστάσεων εποπτείας τους.

αίτημα - URL: https://restapi.smsbat.com/organizations/alpha_name/list - Μέθοδος: ** GET - Κεφαλίδες:** - X-Authorization-Key: {organization_token}

Απάντηση (200 ΟΚ):

[
    {
        "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"
    }
]

Καταστάσεις Alpha Name (statusCode): - PA - Έγκριση σε εκκρεμότητα - A - Εγκρίθηκε - D - Απορρίφθηκε