API

Swagger

Aby przetestować działanie API, możesz wykorzystać zainstalowane narzędzie Swagger.

Autoryzacja

curl -u email:password https://[instance].l2.cloud.cstore.pl/api/auth

  • Skopiuj wygenerowany token.

Lista zasobów

Aby wyświetlić listę zasobów, wykonaj żądanie:

curl -H "Authorization: Bearer [token]" https://[instance].l2.cloud.cstore.pl/api/sources

Zbiorcze pobieranie danych

Przykładowe żądanie:

curl -H "Authorization: Bearer [token]" https://[instance].l2.cloud.cstore.pl/api/users

Paginacja

Aby przejść do kolejnej podstrony z wynikami, skorzystaj z parametru GET page=[numer podstrony].

Aby zmienić domyślny limit zwracanych rekordów, skorzystaj z parametru GET per_page=[limit].

Filtrowanie wyników

Możesz filtrować listę po dowonym polu podstawowym, poprzez skorzystanie z odpowiedniego parametru GET, np. email=admin@cstore.pl.

Możesz też skorzystać z podstawowych operatorów, takich jak >, <, like, not like, !. Przykładowo: email[like]=admin%.

Sortowanie wyników

Aby posortować listę, skorzystaj z parametru GET order=[pole podstawowe],[kierunek (asc/desc)], np. order=email,desc.

Zbiorcze pobieranie danych wraz z relacjami

Przykładowe żądanie:

curl -H "Authorization: Bearer [token]" https://[instance].l2.cloud.cstore.pl/api/users/extended

Pobieranie konkretnego obiektu

Przykładowe żądanie:

curl -H "Authorization: Bearer [token]" https://[instance].l2.cloud.cstore.pl/api/users/[id]

Pobieranie konkretnego obiektu wraz z relacjami

Przykładowe żądanie:

curl -H "Authorization: Bearer [token]" https://[instance].l2.cloud.cstore.pl/api/users/[id]/extended

 

Uwaga!

Relacje typu jeden do wielu lub wiele do wielu podlegają paginacji. Aby wyświetlić kolejne wyniki wszystkich relacji, uwzględnij parametr GET page=[numer podstrony].

Pobieranie wskazanej relacji

Możes też wskazać konkretną relację, która Ciebie interesuje. Przykładowe żądanie:

curl -H "Authorization: Bearer [token]" https://[instance].l2.cloud.cstore.pl/api/users/[id]/invoiceAddress

Wyświetlenie listy potencjalnych relacji

Przykładowe żądanie:

curl -H "Authorization: Bearer [token]" https://[instance].l2.cloud.cstore.pl/api/users/relations

Wyświetlenie listy dostępnych metod

Przykładowe żądanie:

curl -H "Authorization: Bearer [token]" https://[instance].l2.cloud.cstore.pl/api/users/methods

Wyświetlenie listy argumentów przyjmowanych przez metodę

Przykładowe żądanie:

curl -H "Authorization: Bearer [token]" https://[instance].l2.cloud.cstore.pl/api/users/methods/[method]

Pobieranie struktury bazodanowej obiektu

Przykładowe żądanie:

curl -H "Authorization: Bearer [token]" https://[instance].l2.cloud.cstore.pl/api/users/schema

Dodawanie nowych obiektów

Przykładowe żądanie:

curl -X "POST" -H "Content-Type: application/json" -d '{"email": "user@cstore.pl"}' -H "Authorization: Bearer [token]" https://[instance].l2.cloud.cstore.pl/api/users

Modyfikowanie obiektów

Przykładowe żądanie:

curl -X "PUT" -H "Content-Type: application/json" -d '{"email": "user2@cstore.pl"}' -H "Authorization: Bearer [token]" https://[instance].l2.cloud.cstore.pl/api/users/[id]

Wywoływanie metod

Przykładowe żądanie:

curl -X "POST" -H "Content-Type: application/json" -d '{"formatted": true}' -H "Authorization: Bearer [token]" https://[instance].l2.cloud.cstore.pl/api/users/[id]/getBalance

Obiekt modelu jako argument

Jeżeli funkcja przyjmuje jako argument obiekt modelu, możesz go przekazać jako string w formacie :model([pełna nazwa klasy],[id]), np. :model(\App\Models\User,1).

Wywoływanie metod statycznych

Przykładowe żądanie:

curl -X "POST" -H "Content-Type: application/json" -d '{"formatted": true}' -H "Authorization: Bearer [token]" https://[instance].l2.cloud.cstore.pl/api/users/authorized

Usuwanie obiektów

Przykładowe żądanie:

curl -X "DELETE" -H "Authorization: Bearer [token]" https://[instance].l2.cloud.cstore.pl/api/users/[id]