/records
Endpoint
GET https://api.a-i-a.skin/records
queryParams
key(wymagany): (string) Twój unikalny klucz API, który autoryzuje zapytanie.- Przykład:
63e9054c0974e3d3ac26016aa38b1da26f277b961d0cac58e9f6ee0546f55585
- Przykład:
query(wymagany): (string) Min. 5 znaków, Fraza lub ciąg znaków, który chcesz wyszukać.- Przykład:
Flore
- Przykład:
fields(opcjonalny): lista pól, po których można wyszukiwać, oddzielona przecinkami.- Dozwolone wartości: name, dose, form, substance_name, substance_name_pl, manufacturer, force.
- Przykład:
name,dose
Przykłady zapytań
- curl
- PHP
- JavaScript
cURL
curl "https://api.a-i-a.skin/records?key=63e9054c0974e3d3ac26016aa38b1da26f277b961d0cac58e9f6ee0546f55585&query=Flore"
PHP
<?php
$apiUrl = "https://api.a-i-a.skin/records";
$params = [
"key" => "63e9054c0974e3d3ac26016aa38b1da26f277b961d0cac58e9f6ee0546f55585",
"query" => "Flore"
];
$response = file_get_contents($apiUrl . "?" . http_build_query($params));
$data = json_decode($response, true);
print_r($data);
?>
JavaScript (fetch)
const apiUrl = "https://api.a-i-a.skin/records";
const params = new URLSearchParams({
key: "63e9054c0974e3d3ac26016aa38b1da26f277b961d0cac58e9f6ee0546f55585",
query: "Dia"
});
fetch(`${apiUrl}?${params}`)
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error("Error:", error));
Odpowiedź
Odpowiedź zwraca dane w formacie JSON.
Przykładowa odpowiedź:
{
"status": "success",
"data": {
"results": [
{
"id": "fdc36b90ab40e11bfece543c68d1cc439765c0cb26a7bb87d9ca205b2c42d065",
"name": "Diacomit",
"substance_name": "stiripentol",
"substance_name_pl": "styrypentol",
"form": "proszek do sporz. zaw. doustnej",
"dose": "500 mg",
"manufacturer": "Biocodex",
"force": 2
}
]
}
}
Pola odpowiedzi:
status: Status odpowiedzi (successluberror).data: Główna sekcja wyników, zawiera:results: Tablica z obiektami wyników wyszukiwania.id: unikalny identyfikator.name: Nazwa leku.substance_name: Nazwa substancji aktywnej w języku angielskim.substance_name_pl: Nazwa substancji aktywnej w języku polskim.form: Forma farmaceutyczna leku (np. tabletki musujące).dose: Dawka lub skład leku. W przypadku braku informacji: N/A.manufacturer: Producent leku.force: Siła działania: null |1,2,3.- 1: Bezpieczny lek.
- 2: Lek o umiarkowanym działaniu.
- 3: Lek o silnym działaniu.
Błędy
W przypadku błędów zwracany jest status error oraz dodatkowe informacje:
Przykład błędu:
{
"status": "error",
"message": "Invalid API key"
}
Typowe kody błędów:
401: Nieprawidłowy klucz API.400: Brak wymaganego parametrukey.
Uwagi
- Zapytania z nieprawidłowym lub brakującym kluczem API zakończą się błędem.
- Parametr
queryjest opcjonalny, ale bez niego wyniki mogą być ograniczone.