Skip to content

Commit

Permalink
ReadMe
Browse files Browse the repository at this point in the history
  • Loading branch information
Lukegpl committed Jan 4, 2018
1 parent 26de69e commit 6ee289d
Showing 1 changed file with 25 additions and 9 deletions.
34 changes: 25 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,20 +29,20 @@ Poniższy przykład przedstawia pobranie wersji developerskiej.
create-project lukeotdr/api-subiekt-gt --stability dev
```

Paczkę umieszczamy tak aby serwer www miał możliwość uruchomienia plików PHP z katalogu public.
Uruchamiamy konfigurację api poprzez przykładowe poniższe wywyołanie:
Paczkę umieszczamy tak aby serwer www miał możliwość uruchomienia plików PHP z katalogu public lub odpowiednio kinfigurujemy serwer www.
Uruchamiamy konfigurację api poprzez przykładowe poniższe wywołanie:

```
http://192.168.1.1/api-subiekt-gt/public/setup
```

Powyższe wywyołanie uruchomi konfigurator api, który pomoże utworzyć plik konfiguracyjny do połączenia ze Sferą GT
oraz SQLServer-em. Należy przygotować użytkownika, hasło do SQLServera dzięki któremu zostanie nawiązane połączenie z
bazą Subiekta. Jeśli była autentykacja windows trzeba utworzyć użytkownika oraz hasło z dostępem do podmiotu.
Można użyć danych admina "sa" lecz nie zalecane.
Powyższe wywołanie uruchomi konfigurator api, który pomoże utworzyć plik konfiguracyjny do połączenia ze Sferą GT
oraz SQLServer-em. Należy przygotować użytkownika oraz hasło do SQLServera dzięki któremu zostanie nawiązane połączenie z
bazą Subiekta. Jeśli była autentykacja windows trzeba utworzyć takiego użytkownika z dostępem do podmiotu.
Do testów można użyć danych admina "sa" lecz na produkcji nie zalecane.

Po konfiguracji należy jescze przeprowadzić test połączenia podając istniejący numer dokumentu sprzedaży z Subiekta. Np: "PA 13659/12/2017".
W odpowiedzi w przypadku poprawnego połączenia i pobrania danych powinniśmy otrzymać coś podobnego jak poniżej.
W odpowiedzi i poprawnego połączenia powinniśmy zobaczyć coś podobnego jak poniżej.

Wysłane rządanie:

Expand All @@ -58,7 +58,7 @@ Wysłane rządanie:

XXXXXXXXXXXXXXXXXXXXXX - wygenerowane api key.

Odebrana odpoweiedź:
Odebrana odpowiedź:

```
{
Expand Down Expand Up @@ -108,10 +108,26 @@ Odebrana odpoweiedź:


Jeśli udało się połączyć z bazą danych to teraz nie pozostaje nic innego jak utworzyć interfejs do komunikacji z api.
Rządania do api w powyższym przykładzie wysyłamy na adres:

```
http://192.168.1.1/api-subiekt-gt/public/api/
przykładowe wywołanie:
http://192.168.1.1/api-subiekt-gt/public/api/document/get
```

Gdyby zaszła potrzeba użyć IIS-a jako serwera www to rządania bez modułu "rewrite" miałyby postać:

```
http://192.168.1.1/api-subiekt-gt/public/api?c=document/get
```

## Dokumentacja API

Dokumentacja metod API: [Dokumentacja]()
Dokumentacja metod API: [Dokumentacja](docs/api.md)

## License

Expand Down

0 comments on commit 6ee289d

Please sign in to comment.