Referință API¶
Gestionarea erorilor¶
Notă
Componenta MPower Client API va returna erorile REST API cu codul de eroare și cauza; descrierile vor fi afișate în limba engleză.
| Cod eroare | Descriere |
|---|---|
| AuthenticationFailed | Procesul de autentificare a consumatorului serviciului a eșuat. Vezi secțiunea Autentificare |
| InvalidParameter | Un parametru de intrare este invalid. Consultați textul Fault Reason returnat și descrierea operațiunii apelate. |
| 200 | Succes |
| 400 | Cerere invalidă, validarea a eșuat. Verificați respectarea regulilor de validare |
| 401 | Acces neautorizat. Verificați cerințele de autorizare |
| 403 | Interzis. Acțiunea solicitată nu este permisă pentru ID-ul transmis |
| 404 | Negăsit. Verificați datele trimise în cerere |
| 500 | A survenit o eroare de server. Lipsă conexiune cu baza de date, din alte motive decât: 400 / 401 / 501. Contactați administratorul. |
| 501 | A survenit o eroare de server. Contactați administratorul. |
Descrierea metodelor API¶
Verificarea valabilității împuternicirii¶
Notă
Deoarece această metodă poate fi apelată de mai multe ori, în zile/momente diferite, răspunsul poate varia: la un anumit moment împuternicirea poate să nu mai fie valabilă din cauza expirării, revocării, renunțării, suspendării etc.
| Semnătura apelului | GET /api/Authorization/check/Code-True-One | |
|---|---|---|
| Descriere | Pe baza codului de împuternicire, returnează o înregistrare care indică dacă împuternicirea este valabilă sau anulată. | |
| Parametri de intrare/ieșire | ||
| Nume | Tip | Descriere |
| Query | "authorizationCode" | Codul unic de identificare, din 16 cifre, al împuternicirii. |
| Response | "data": = True sau False | Dacă valoarea returnată este True, împuternicirea este valabilă; dacă este False, nu este valabilă. |
| Erori (Faults) | ||
| Cod | Motiv | |
| 200 | Succes | |
| 404 | Negăsit. Verificați datele trimise în cerere | |
| 500 | A survenit o eroare de server. Lipsă conexiune cu baza de date, din alte motive decât: 400 / 401 / 501. Contactați administratorul. | |
| 501 | A survenit o eroare de server. Contactați administratorul. | |
Obținerea detaliilor împuternicirii¶
| Semnătura apelului | GET /api/Authorization/check/Code-Details-One | |
|---|---|---|
| Descriere | Pe baza codului de împuternicire, returnează o înregistrare cu o structură de date care conține detaliile împuternicirii identificate. | |
| Parametri de intrare/ieșire | ||
| Nume | Tip | Descriere |
| Query | "authorizationCode" | Codul unic de identificare, din 16 cifre, al împuternicirii. |
| Response | AuthorizationDetails | O structură de date care conține detaliile împuternicirii identificate. |
| Erori (Faults) | ||
| Cod | Motiv | |
| 200 | Succes | |
| 404 | Negăsit. Verificați datele trimise în cerere | |
| 500 | A survenit o eroare de server. Lipsă conexiune cu baza de date, din alte motive decât: 400 / 401 / 501. Contactați administratorul. | |
| 501 | A survenit o eroare de server. Contactați administratorul. | |
Verificarea valabilității împuternicirii după codul tipului¶
| Semnătura apelului | GET /api/Authorization/check/TypeCode-Valid-One | |
|---|---|---|
| Descriere | Pe baza codului tipului de împuternicire, Idn1 și Idn2, returnează o înregistrare cu o structură de date care indică dacă împuternicirea este valabilă sau anulată. | |
| Parametri de intrare/ieșire | ||
| Nume | Tip | Descriere |
| Query | AuthorizationTypeCodeQuery | O structură de date care conține detaliile împuternicirii identificate pe baza codului tipului de împuternicire. |
| Response | AuthorizationValid | O structură de date referitoare la împuternicire, care indică valabilitatea acesteia: True sau False. |
| Erori (Faults) | ||
| Cod | Motiv | |
| 200 | Succes | |
| 404 | Negăsit. Verificați datele trimise în cerere | |
| 500 | A survenit o eroare de server. Lipsă conexiune cu baza de date, din alte motive decât: 400 / 401 / 501. Contactați administratorul. | |
| 501 | A survenit o eroare de server. Contactați administratorul. | |
Obținerea listei de împuterniciri după IDNx¶
| Semnătura apelului | GET /api/Authorization/check/Idn-Details-List | |
|---|---|---|
| Descriere | Pe baza IDNP sau IDNO, returnează lista de împuterniciri. | |
| Parametri de intrare/ieșire | ||
| Nume | Tip | Descriere |
| Query | AuthorizationListQuery | Identificare pe baza IDNP sau IDNO și, opțional, o structură suplimentară cu date referitoare la împuternicire. |
| Response | AuthorizationDetails | O structură de date care conține detaliile împuternicirilor. |
| Erori (Faults) | ||
| Cod | Motiv | |
| 200 | Succes | |
| 404 | Negăsit. Verificați datele trimise în cerere | |
| 500 | A survenit o eroare de server. Lipsă conexiune cu baza de date, din alte motive decât: 400 / 401 / 501. Contactați administratorul. | |
| 501 | A survenit o eroare de server. Contactați administratorul. | |
Descărcarea fișierului de împuternicire¶
| Semnătura apelului | GET /api/Authorization/file | |
|---|---|---|
| Descriere | Pe baza codului de împuternicire, returnează o înregistrare cu o structură de date care conține fișierul de împuternicire. | |
| Parametri de intrare/ieșire | ||
| Nume | Tip | Descriere |
| Query | authorizationCode | O structură de date care conține detaliile împuternicirii identificate pe baza codului de împuternicire. |
| Response | AuthorizationFile | O structură de date care conține fișierul de împuternicire. |
| Erori (Faults) | ||
| Cod | Motiv | |
| 200 | Succes | |
| 404 | Negăsit. Verificați datele trimise în cerere | |
| 500 | A survenit o eroare de server. Lipsă conexiune cu baza de date, din alte motive decât: 400 / 401 / 501. Contactați administratorul. | |
| 501 | A survenit o eroare de server. Contactați administratorul. | |
Structuri de date (Query)¶
| Membru | Tip | Obligatoriu/Opțional | Descriere |
|---|---|---|---|
| AuthorizationTypeCodeQuery | |||
| AuthorizationTypeCode | String | Obligatoriu | Introduceți codul tipului de împuternicire (atribuit din formularul aprobat, 10 caractere – „AT-xxxxxxx"). |
| AuthorizingIdn | String | Obligatoriu | Introduceți IDNP sau IDNO al persoanei reprezentate.
Trebuie să conțină exact 13 caractere și doar cifre. |
| AuthorizedIdn | String | Obligatoriu | Introduceți IDNP sau IDNO al reprezentantului.
Trebuie să conțină exact 13 caractere și doar cifre. |
| AuthorizationListQuery | |||
| IDNx | String | Obligatoriu | Va fi returnată lista de împuterniciri acordate și primite de IDNP sau IDNO introdus (unde persoana fizică sau juridică are rolul de reprezentat și reprezentant).
Trebuie să conțină exact 13 caractere și doar cifre. Va fi comparat pentru a fi identic cu AuthorizingContextIdn și AuthorizedIdn. |
| Status | Integer | Opțional | Filtrează lista de împuterniciri acordate și primite în funcție de statutul indicat.
Trebuie să conțină codul statutului conform enumerărilor indicate în secțiunea Enumerări. Va fi comparat pentru a fi identic cu Authorization Status. |
| AuthorizationTypeCode | String | Opțional | Introduceți codul tipului de împuternicire (atribuit din formularul aprobat, 10 caractere – „AT-xxxxxxx"). |
| StartDate | String | Opțional | Afișează împuternicirile care au devenit valabile începând cu data indicată.
Constrângeri: această valoare nu trebuie să fie ulterioară valorii introduse în câmpul EndDate. Ora este setată în UTC. Exemplu: „2020-09-28T10:35:16.879Z". Va fi comparată pentru a fi mai mare sau egală cu data AuthorizationValidFrom (AuthorizationValidFrom reprezintă data la care împuternicirea a devenit valabilă). |
| AuthEndDateorizationTypeCode | String | Opțional | Afișează împuternicirile care au expirat până la data indicată.
Constrângeri: această valoare nu trebuie să fie anterioară valorii introduse în câmpul StartDate. Ora este setată în UTC. Exemplu: „2020-09-28T10:35:16.879Z". Va fi comparată pentru a fi mai mare sau egală cu data AuthorizationValidTo (AuthorizationValidTo reprezintă data expirării împuternicirii). |
| GrantedByIdn | String | Opțional | Acest parametru va afișa lista de împuterniciri acordate de IDNP/IDNO specificat.
Constrângeri: valoarea acestui câmp trebuie să fie diferită de valoarea câmpului GrantedToIdn. Trebuie să conțină 13 caractere, toate cifre. Va fi comparat pentru a fi egal cu AuthorizingContextIdn. |
| GrantedToIdn | String | Opțional | Afișează lista de împuterniciri primite de la IDNP/IDNO specificat.
Constrângeri: valoarea acestui câmp trebuie să fie diferită de valoarea câmpului GrantedByIdn. Trebuie să conțină 13 caractere, toate cifre. Va fi comparat pentru a fi egal cu AuthorizedIdn. |
| ItemsPerPage | Integer | Opțional | Parametrul specifică pagina care va fi afișată. Implicit, sunt afișate înregistrările din prima pagină.
Constrângeri: dacă se introduce un număr negativ sau zero, sistemul va returna împuternicirile din prima pagină; dacă se introduce un număr mai mare decât numărul de pagini, va fi afișat câte zero împuterniciri pe pagină. |
Structuri de date (Response)¶
| Membru | Tip | Obligatoriu/Opțional | Descriere |
|---|---|---|---|
| AuthorizationCodeValid | |||
| AuthorizationCode | String | Obligatoriu | Codul unic de identificare al împuternicirii. |
| IsValid | String | Obligatoriu | True dacă este valabilă
False dacă nu este valabilă |
| AuthorizationDetails | |||
| AuthorizationCode | String | Obligatoriu | Codul unic de identificare al împuternicirii. |
| AuthorizationTypeCode | String | Obligatoriu | Codul tipului de împuternicire (conform formularului aprobat). |
| AuthorizingPartyType | Integer | Obligatoriu | ID-ul tipului persoanei reprezentate; vezi secțiunea Enumerări. |
| AuthorizingIdn | String | Obligatoriu | IDNP sau IDNO al persoanei reprezentate. |
| AuthorizedPartyType | Integer | Obligatoriu | ID-ul tipului părții reprezentante; vezi secțiunea Enumerări. |
| AuthorizedIdn | String | Obligatoriu | IDNP sau IDNO al reprezentantului. |
| From | String | Obligatoriu | Dacă isValid=True -> Data de la care împuternicirea este valabilă.
Dacă isValid=False -> Data de la care împuternicirea este suspendată sau nevalabilă. Ora este setată în UTC. |
| To | String | Obligatoriu | Dacă isValid=True -> Data până la care împuternicirea este valabilă.
Dacă isValid=False -> „null". Ora este setată în UTC. |
| IsValid | String | Obligatoriu | True dacă este valabilă
False dacă nu este valabilă |
| AuthorizingPartyName | String | Obligatoriu | Numele și prenumele persoanei reprezentate. |
| AuthorizedPartyName | String | Obligatoriu | Numele și prenumele reprezentantului. |
| AuthorizationTypeName | String | Obligatoriu | Denumirea tipului de împuternicire. |
| ServiceProviderIdno | String | Obligatoriu | IDNO-ul prestatorului de servicii. |
| ServiceProviderName | String | Obligatoriu | Denumirea prestatorului de servicii. |
| AuthorizationFile | |||
| content | byte[] | Obligatoriu | Conținutul fișierului care conține date despre împuternicirea solicitată. |
| content-type | String | Obligatoriu | Tipul MIME al fișierului de împuternicire. Implicit: „application/pdf" |
Enumerări¶
| Atribute | Descriere | |
|---|---|---|
| AuthorizationGrantedType | ||
| 1 | Împuternicire acordată de IDNx | |
| 2 | Împuternicire primită de IDNx | |
| 3 | Împuternicire cosemnată de IDNx | |
| AuthorizationStaus | ||
| Draft | Împuternicirea este creată, dar nu este valabilă | None |
| PendingAcceptance | Împuternicirea este acordată, dar necesită acceptarea reprezentantului pentru a deveni valabilă | None |
| Pending | Împuternicirea este acordată, dar va deveni valabilă la o dată viitoare | None |
| Valid | Împuternicirea este valabilă și poate fi utilizată pentru reprezentare | isValid=True |
| Canceled | Împuternicirea a expirat, a fost revocată sau i s-a renunțat | isValid=False |
| Suspended | Împuternicirea este suspendată | isValid=False |
| AuthorizingPartyType | ||
| 1 | Persoană fizică | |
| 2 | Persoană juridică | |
| AuthorizedPartyType | ||
| 1 | Persoană fizică | |
| 2 | Persoană juridică | |
| Status | ||
| 1 | Împuternicirea salvată ca ciornă (neacordată) | Draft |
| 2 | Împuternicirea care a fost acordată, dar necesită acceptarea reprezentantului pentru a deveni valabilă | PendingAcceptance |
| 3 | Împuternicirea care a fost acordată, dar data de intrare în vigoare este viitoare | PendingValidity |
| 4 | Împuternicirea care este valabilă. | Valid |
| 5 | Împuternicirea care este suspendată. | Suspended |
| 6 | Împuternicirea care nu este valabilă din cauza expirării, renunțării, revocării | Canceled |
Exemple de apeluri ale metodelor API¶
GET /api/Authorization/check/Code-True-One¶
curl -X GET "https://mpower.staging.egov.md:8443/clients-api/api/Authorization/check/Code-True-One?AuthorizationCode=0200905142878268" -H "accept: text/plain"
{
"data": true,
"success": true,
"messages": []
}
GET /api/Authorization/check/Code-Details-One¶
curl -X GET "https://mpower.staging.egov.md:8443/clients-api/api/Authorization/check/Code-Details-One?AuthorizationCode=0200935852951597" -H "accept: text/plain"
{
"data": {
"authorizationCode": "0200935852951597",
"authorizationTypeCode": "AT-2100025",
"authorizingPartyType": 2,
"authorizingIdn": "1009600026622",
"authorizedPartyType": 1,
"authorizedIdn": "2001003328546",
"fromDate": "2020-09-22T14:16:06.0932925",
"toDate": "2021-03-22T21:59:59.999",
"isValid": true,
"authorizingPartyName": "Esempla SRL",
"authorizedPartyName": "L CHIRIŢA",
"authorizationTypeName": "Ridicare original document",
"serviceProviderIdno": "1009600026622",
"serviceProviderName": "Companie SRL"
},
"success": true,
"messages": []
}
GET /api/Authorization/check/TypeCode-Valid-One¶
curl -X GET "https://mpower.staging.egov.md:8443/clients-api/api/Authorization/check/TypeCode-Valid-One?AuthorizationTypeCode=AT-2100025&AuthorizingIdn=1009600026622&AuthorizedIdn=2001003328546" -H "accept: text/plain"
{
"data": {
"authorizationCode": "0200935852951597",
"isValid": true
},
"success": true,
"messages": []
}
GET /api/Authorization/check/Idn-Details-List¶
!NEFURNIZAT ÎN DOCUMENTAȚIA ANTERIOARĂ
GET /api/Authorization/file¶
curl -X GET "https://mpower.staging.egov.md:8443/clients-api/api/Authorization/file ? ?AuthorizationCode=0200905142878268" " -H "accept: text/plain"
{
"data": {
"content": "JVBERi0xLjcKJeLjz9MKNyAwIG9iago8PC9GaWx0ZXI…",
"content-type": "application/pdf"
},
"success": true,
"messages": []
}