/api/v1/client/search
Requires authentication
Rate limited by the `api-global` limiter
v1
Send a bearer token, plus the X-Client-Id and X-Client-Secret headers in the Authorization header.
Kërkon një biznes në regjistrin fiskal sipas NIPT-it dhe kthen emrin, adresën, qytetin dhe shtetin e tij.
Përdoreni për të plotësuar të dhënat e një klienti të ri nga një fushë e vetme, ose për të
kapur një NIPT të gabuar para se të dalë në faturë. Për klientët që keni ruajtur tashmë në
fature.al përdorni GET /clients me query.
verified thotë nëse regjistri e konfirmoi biznesin. Dy përgjigjet e refuzimit nuk janë e
njëjta gjë:
404: NIPT-i nuk është në regjistër.503: regjistri nuk u arrit dhe NIPT-i mbeti i pakontrolluar. Riprovoni më vonë.
URL-ja e plotë: https://fature.al/api/v1/client/search
Query parameters
| Name | Tipi | E detyrueshme | Përshkrimi |
|---|---|---|---|
| nuis | string | yes | NIPT-i i biznesit që kërkohet, në formatin X00000000X. |
Përgjigjet
200 Biznesi që u gjet te `client`, me `verified: true`.
| Field | Tipi | Përshkrimi |
|---|---|---|
| status | boolean | |
| data | object | |
| data.client | object | |
| data.client.nuis | string | NIPT-i i biznesit, siç është në regjistër |
| data.client.name | string | Emri i biznesit |
| data.client.address | string | Adresa e biznesit |
| data.client.city | string | Qyteti i biznesit |
| data.client.country | integer | Id-ja e shtetit në fature.al, e njëjta që kthehet si `nationality_id` te klientët |
| data.client.country_code | string | Kodi ISO 3166-1 alpha-3 i shtetit; `ALB` për një biznes që vjen nga regjistri fiskal |
| data.client.verified | boolean | true: biznesi u konfirmua, nga regjistri fiskal ose nga një klient i verifikuar më parë në fature.al. Një NIPT që nuk konfirmohet nuk kthehet me 200, por me `404` |
401 Unauthenticated
| Field | Tipi | Përshkrimi |
|---|---|---|
| message | string |
404 NIPT-i nuk është në regjistrin fiskal.
| Field | Tipi | Përshkrimi |
|---|---|---|
| status | boolean | Gjithmonë false. Një përgjigje e suksesshme mban `status: true` dhe objektin `data` |
| message | string | Përshkrimi i gabimit. Bosh kur dështimi nuk mban ndonjë mesazh të vetin |
| errors | array | Mesazhe për t'u shfaqur te përdoruesi ose për t'u ruajtur në log. Mungon kur nuk ka gjë për të shtuar përtej `message` |
422 NIPT-i mungon ose nuk është në formatin X00000000X. Kjo përgjigje përdor fushën `success`, jo `status`, dhe `errors` është objekt sipas fushës.
| Field | Tipi | Përshkrimi |
|---|---|---|
| success | boolean | Gjithmonë false |
| message | string | Një rresht përmbledhës, i njëjtë për çdo dështim validimi |
| errors | object | Fushat që nuk kaluan validimin, secila me mesazhet e veta. Çelësat me pikë tregojnë brenda objekteve dhe elementëve të array-ve, p.sh. `lines.0.quantity` |
503 Regjistri fiskal nuk u arrit dhe NIPT-i mbeti i pakontrolluar. Riprovoni më vonë.
| Field | Tipi | Përshkrimi |
|---|---|---|
| status | boolean | Gjithmonë false. Një përgjigje e suksesshme mban `status: true` dhe objektin `data` |
| message | string | Përshkrimi i gabimit. Bosh kur dështimi nuk mban ndonjë mesazh të vetin |
| errors | array | Mesazhe për t'u shfaqur te përdoruesi ose për t'u ruajtur në log. Mungon kur nuk ka gjë për të shtuar përtej `message` |
Shembull kërkese
curl -X GET 'https://fature.al/api/v1/client/search?nuis=L91806031A' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'X-Client-Id: YOUR_CLIENT_ID' \
-H 'X-Client-Secret: YOUR_CLIENT_SECRET' \
-H 'Accept: application/json'use Illuminate\Support\Facades\Http;
$response = Http::withHeaders([
'Authorization' => 'Bearer YOUR_TOKEN',
'X-Client-Id' => 'YOUR_CLIENT_ID',
'X-Client-Secret' => 'YOUR_CLIENT_SECRET',
'Accept' => 'application/json',
])->get('https://fature.al/api/v1/client/search?nuis=L91806031A');
$data = $response->json();use GuzzleHttp\Client;
$client = new Client();
$response = $client->request('GET', 'https://fature.al/api/v1/client/search?nuis=L91806031A', [
'headers' => [
'Authorization' => 'Bearer YOUR_TOKEN',
'X-Client-Id' => 'YOUR_CLIENT_ID',
'X-Client-Secret' => 'YOUR_CLIENT_SECRET',
'Accept' => 'application/json',
],
]);
$data = json_decode((string) $response->getBody(), true);const response = await fetch('https://fature.al/api/v1/client/search?nuis=L91806031A', {
method: 'GET',
headers: {
'Authorization': 'Bearer YOUR_TOKEN',
'X-Client-Id': 'YOUR_CLIENT_ID',
'X-Client-Secret': 'YOUR_CLIENT_SECRET',
'Accept': 'application/json'
}
});
const data = await response.json();Shembull përgjigjeje
{
"status": true,
"data": {
"client": {
"nuis": "L91806031A",
"name": "Alpha SHPK",
"address": "Rruga e Kavajës 12",
"city": "Tiranë",
"country": 3,
"country_code": "ALB",
"verified": true
}
}
}{
"message": "Unauthenticated."
}{
"status": false,
"message": "Te dhenat jo te sakta.",
"errors": [
"errors"
]
}{
"success": false,
"message": "Te dhena jo te sakta",
"errors": []
}{
"status": false,
"message": "Te dhenat jo te sakta.",
"errors": [
"errors"
]
}