Η Πλατφόρμα Δέσμευσης και Άρσης Φορολογικής Ενημερότητας, παρέχει api για σύνδεση με τρίτες εφαρμογές.
Για να κάνουμε δημιουργία εφαρμογής στο GovHub, θα κάνουμε τα παρακάτω βήματα.
Για να καλέσουμε τα api πρώτα πρέπει έχουμε κάνει authenticate σαν εφαρμογή και να πάρουμε ένα JWT Token.
Για το παραγωγικό περιβάλλον στο πεδίο scope συμπληρώνουμε DesmefsiForologikis.Basic για το Δοκιμαστικό περιβάλλον στο πεδίο scope συμπληρώνουμε DesmefsiForologikis.Test.
Οδηγίες για λήψη JTW token από τον auth Server
Αφού λάβετε το JWT Token σύμφωνα με το Auth 2.0 πρότυπο θα πρέπει να κάνετε Bearer Authentication.
Authorization: Bearer <token>
Αφού ρυθμίσετε τους παραπάνω headers μπορείτε να κάνετε κλήσεις σύμφωνα με τις οδηγίες του OpenApi(παράγραφος 1 docs).
Με την κλήση POST api/arxeio/CreateFromClient μπορείτε να δημιουργήσετε αρχείο με δεσμεύσεις. Θα πρέπει στην κλήση αυτή να προσθέσετε ένα header GovHub-UserName με τιμή το username του χρήστη στο GovHub που πραγματοποιεί την ενέργεια.
Πληροφορίες για το μοντέλο θα βρείτε στα Links της ενότητας 1.
Περιορισμοί και πληροφορίες:
sigxronismosStoicheionApoGovHub true. Τα στοιχεία αυτά δεν είναι απαραίτητα για την αποστολή των δεσμεύσεων είναι πληροφοριακά.sendAfterCreate true. Εναλλακτικά θα πρέπει να γίνει εκκίνηση της διαδικασίας αποστολής με μεταγενέστρο http call που θα περιγραφεί παρακάτωΠιθανά Σφάλματα:
| Περιγραφή | Λεπτομέριες | Πρόταση |
|---|---|---|
| Δε βρέθηκε οργανισμός | Δεν βρέθηκε οργανισμός απο τα claims του token | Ελέξτε το token αν περιέχει το organizationId |
| Δε βρέθηκε αντιστοίχιση του οργανισμού | Εσωτερικό σφάλμα | Επικοινωνήστε με το helpdesk |
| Δεν έχει οριστεί χρήστης Gov-Hub για την δημιουργία μέσω client | Ελέξτε το header `GovHub-UserName` | |
| Σφάλμα κατά την αποθήκευση των δεδομένων | Εσωτερικό σφάλμα | Δοκιμάστε ξανά μετα απο λίγο και σε δεύτερο χρόνο επικοινωνήστε με το helpdesk |
Σε περίπτωση που δεν πάρετε τα παραπάνω σφάλματα θα πάρετε πίσω απάντηση στη μορφή:
{ "id": 0, "errors": [ { "isStoppingError": true, "errorMessage": "string" } ] }
Αν το id είναι 0 τότε δεν έχει δημιουργηθεί αρχείο και υπάρχει εξήγηση στην λίστα με τα errors.
Σε περτίπωστη που id > 0 τότε έχει δημιουργηθεί αρχείο και έχει ξεκινήσει η δημιουργία των δεσμεύσεων.
Η δημιουργία του αρχείου είναι ασύγχρονη με την δημιουργία των δεσμεύσεων. Αυτό σημαίνει ότι την στιγμή που θα λάβετε id δεν ειναι σίγουρο ότι οι δεσμέυσεις έχουν δημιουργηθεί. Θα πρέπει να γίνει κλήση api/arxeio/getById/{arxeioId} για να λάβετε το status και σύμφωνα με αυτό να προχωρήσετε.
Σε περίπτωση που η τιμή sendAfterCreate είναι true τότε το αρχείο αυτόματα θα πάει προς αποστολή αν ολοκληρωθεί επιτυχώς η δημιουργία των δεσμεύσεων.
Χρήσιμες κλήσεις:
api/arxeio/getById/{arxeioId}api/arxeio/GetByIdMeDesmefseis/{arxeioId}Στο σενάριο που δεν έχετε κάνει αυτόματη αποστολή μετα την δημιουργία μπορείτε να χρησιμοποιήσετε την κλήση GET api/arxeio/ApostoliDesmefseon/{arxeioId} για να γίνει εκκίνηση της αποστολής.
Πιθανά Σφάλματα :
| Περιγραφή | Λεπτομέριες | Πρόταση |
|---|---|---|
| Δε βρέθηκε οργανισμός | Δεν βρέθηκε οργανισμός απο τα claims του token | Ελέξτε το token αν περιέχει το organizationId |
| Δε βρέθηκε αντιστοίχιση του οργανισμού | Εσωτερικό σφάλμα | Επικοινωνήστε με το helpdesk |
| Δεν έχετε συμπληρώσει τα στοιχεία που απαιτούνται στις ρυθμίσεις του οργανισμού σας | Πρέπει να μπεί χρήστης στο UI της εφαρμογής και να σημπληρώσει τα στοιχεία οργανισμού.Δεν χρειάζεται να είναι διαχειριστής | |
| Δεν έχει οριστεί χρήστης Gov-Hub για την αποστολή μέσω client | Ελέξτε το header `GovHub-UserName` | |
| Δεν βρέθηκε αρχείο με Id {arxeioId} | Ελέγξτε τα δεδομένα σας. | |
| Το αρχείο {arxeioId} είναι ήδη σε διαδικασία αποστολής | ||
| Το αρχείο {arxeioId} δεν είναι σε κατάσταση κατάλληλη για αποστολή | Ελέγξτε την κατάσαση του αρχείου με την getById. Αν το αρχείο έχει σφάλματα πρέπει να κάνετε δημιουργία νέου |
Τα ΑΦΜ που μπορείτε να χρησιμοποιήσετε στο δοκιμαστικό περιβάλλον είναι τα παρακάτω.
| ΑΦΜ |
|---|
| 660073187 |
| 988047792 |
| 660073151 |
| 660073163 |
| 660073175 |
| 988047780 |
| 988047800 |
| 988047811 |