Credentials upload¶

Ορίζετε ή αλλάζετε μόνοι σας τους λογαριασμούς σας στις ασφαλιστικές (username, password, κωδικούς), χωρίς να μας τους στείλετε.

Prerequisites

Έγκυρο bearer token, όπως σε κάθε άλλη κλήση. Δείτε το Getting started.
Ο client σας χρειάζεται τον ρόλο credentials:manage. Ζητήστε τον από το Support. Χωρίς αυτόν παίρνετε 403.

Αλλάζετε μόνο τα credentials του δικού σας client.
Αλλάζετε τις ασφαλιστικές που ήδη έχετε. Για νέα ασφαλιστική, επικοινωνήστε με το Support.
Οι απαντήσεις δεν περιέχουν ποτέ τιμές, μόνο ονόματα κλειδιών και αν έχουν τιμή.

Τα βήματα¶

GET για να δείτε τα κλειδιά κάθε ασφαλιστικής και την κατάστασή τους.
PUT μία φορά ανά ασφαλιστική, με όλο το block.
PATCH αργότερα, για να αλλάξετε μόνο κάποια κλειδιά.
Οι αλλαγές ισχύουν στις επόμενες κλήσεις σας μέσα σε περίπου 20 δευτερόλεπτα. Ελέγξτε με τα Health checks.

1. Δείτε τι έχει οριστεί¶

curl -s "https://api.insurancegateway.gr/clients/me/credentials" \
  -H "Authorization: Bearer $TOKEN"

{
  "clientId": "your-client-id",
  "providers": [
    {
      "provider": "Apeiron",
      "keys": [
        { "key": "Password", "status": "set" },
        { "key": "Username", "status": "set" }
      ],
      "unknownKeys": [],
      "valid": true,
      "problems": [],
      "fullUploadDone": false
    }
  ],
  "availableProviders": [ "Allianz", "...", "Ydrogeios" ]
}

Πεδίο	Τι σημαίνει
`keys`	Όλα τα κλειδιά που δέχεται η ασφαλιστική. `status`: `set` (έχει τιμή), `empty` (υπάρχει χωρίς τιμή), `missing` (λείπει)
`unknownKeys`	Κλειδιά στο block σας που η ασφαλιστική δεν χρησιμοποιεί. Το επόμενο `PUT` σας τα αφαιρεί
`valid`	`false` = η ασφαλιστική θα απορρίπτει τις κλήσεις σας μέχρι να συμπληρωθούν οι ρυθμίσεις στο `problems`· `null` = δεν ελέγχθηκε
`fullUploadDone`	`true` αφού στείλετε όλο το block με `PUT`. Μέχρι τότε το `PATCH` απορρίπτεται

Τα ονόματα κλειδιών του παραδείγματος είναι ενδεικτικά: κάθε ασφαλιστική έχει τα δικά της. Χρησιμοποιείτε πάντα τα ονόματα που δείχνει το GET για τη συγκεκριμένη ασφαλιστική.

2. Στείλτε όλο το block (`PUT`)¶

curl -s -X PUT "https://api.insurancegateway.gr/clients/me/credentials/apeiron" \
  -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" \
  -d '{ "Username": "my-user", "Password": "my-password" }'

Το body είναι απλό JSON: ένα κλειδί, μία τιμή κειμένου.
Αντικαθιστά όλο το block της ασφαλιστικής. Ένα κλειδί που δεν στέλνετε αφαιρείται, οπότε στείλτε όλα όσα χρειάζεστε. Οι άλλες ασφαλιστικές δεν αλλάζουν.
Για εμφωλευμένα κλειδιά χρησιμοποιήστε __, π.χ. Users__TPL__Password.
Πριν την αποθήκευση γίνεται ο ίδιος έλεγχος με κάθε κλήση. Αν αποτύχει, δεν αλλάζει τίποτα και παίρνετε 400 με invalidSettings (μόνο ονόματα ρυθμίσεων).

3. Αλλάξτε μόνο κάποια κλειδιά (`PATCH`)¶

Μόνο αφού στείλετε εσείς PUT για τη συγκεκριμένη ασφαλιστική (fullUploadDone: true).

curl -s -X PATCH "https://api.insurancegateway.gr/clients/me/credentials/apeiron" \
  -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" \
  -d '{ "Password": "my-new-password" }'

Αλλάζουν μόνο τα κλειδιά που στέλνετε· τα υπόλοιπα μένουν. Κενή τιμή ("") αδειάζει ένα κλειδί.
Ίδια κλειδιά, όρια και έλεγχος με το PUT.
Αν δεν έχετε στείλει όλο το block, ή αν άλλαξε από εμάς στο μεταξύ, παίρνετε 409 και δεν αλλάζει τίποτα. Στείλτε ξανά όλο το block με PUT. Έτσι το νέο σας password δεν καταλήγει δίπλα σε username που δεν είναι δικό σας.

Αφαίρεση ασφαλιστικής¶

Δεν υπάρχει DELETE, σκόπιμα: δεν θα μπορούσατε να επαναφέρετε ένα block που αφαιρέσατε. Επικοινωνήστε με το Support.

Όρια¶

1 έως 64 κλειδιά ανά κλήση, κάθε τιμή έως 1.024 χαρακτήρες, body έως 16 KB.
Χωρίς αλλαγές γραμμής ή άλλους χαρακτήρες ελέγχου στις τιμές.
Διευθύνσεις server (URLs) δεν ανεβαίνουν: τις ορίζουμε εμείς.
10 κλήσεις το λεπτό.

Λάθη¶

Status	`category`	Τι σημαίνει
`400`	`client_credentials_invalid_request`	Άγνωστη ασφαλιστική ή κλειδί, ή τιμή που δεν γίνεται δεκτή (το `errors` λέει ποιο κλειδί)
`400`	`client_credentials_invalid`	Τα credentials αποτυγχάνουν στον έλεγχο (`invalidSettings`)· δεν αποθηκεύτηκε τίποτα
`403`	`client_credentials_forbidden`	Ο client σας δεν έχει τον ρόλο `credentials:manage`
`404`	`client_credentials_file_not_found`	Δεν έχει ανοιχτεί ακόμα αρχείο credentials για τον client σας· επικοινωνήστε με το Support
`404`	`client_credentials_provider_not_configured`	Δεν υπάρχει block για αυτή την ασφαλιστική· ζητήστε από το Support να την προσθέσει
`409`	`client_credentials_full_upload_required`	`PATCH` πριν από πλήρες `PUT`, ή μετά από αλλαγή από εμάς· στείλτε όλο το block με `PUT`
`413`	`client_credentials_body_too_large`	Body πάνω από 16 KB
`429`	—	Πάνω από 10 κλήσεις το λεπτό· περιμένετε και ξαναδοκιμάστε
`503`	`client_credentials_store_busy` / `client_credentials_store_unavailable`	Προσωρινό πρόβλημα· ξαναδοκιμάστε σε λίγο

Όλες οι λεπτομέρειες της κλήσης: Interactive docs.