Specyfikacja plików w formacie CSV: Różnice pomiędzy wersjami
mNie podano opisu zmian |
mNie podano opisu zmian |
||
| Linia 120: | Linia 120: | ||
{| class="wikitable" | {| class="wikitable" | ||
|- | |- | ||
! | ! Metoda !! URL | ||
|- | |- | ||
| POST || /import/categories | | POST || /import/categories | ||
| Linia 137: | Linia 137: | ||
'Content-Type: text/csv' https://nazwa_domeny/import/categories | 'Content-Type: text/csv' https://nazwa_domeny/import/categories | ||
Specyfikacja pliku z kategoriami | '''Specyfikacja pliku z kategoriami''' | ||
Plik musi być w formacie csv z następującą kolejnością pól | Plik musi być w formacie csv z następującą kolejnością pól | ||
id,nadrzedna_id,nazwa,opis | id,nadrzedna_id,nazwa,opis | ||
| Linia 155: | Linia 155: | ||
| opis || Opis kategorii || | | opis || Opis kategorii || | ||
|} | |} | ||
'''<big>4. Tworzenie lub modyfikacja producentów</big>''' | |||
''Tab. 10. Żądanie'' | |||
{| class="wikitable" | |||
|- | |||
! Metoda !! URL | |||
|- | |||
| POST || /import/brands | |||
|} | |||
''Tab. 11. Parametry żądania'' | |||
{| class="wikitable" | |||
|- | |||
! Typ !! Parametr !! Wartość | |||
|- | |||
| HEAD || X-ApiKey || string | |||
|} | |||
''Przykład użycia curl:'' | |||
curl -F 'file=@/ścieżka/do/pliku' -H 'X-ApiKey: klucz' -H "X-Token: token" -H | |||
'Content-Type: text/csv' https://nazwa_domeny/import/brands | |||
'''Specyfikacja pliku z producentami''' | |||
Plik musi być w formacie csv z następującą kolejnością pól | |||
id,nazwa | |||
kolejni producenci muszą być oddzieleni znakiem nowej linii | |||
''Tab. 12. Opis pól pliku z producentami'' | |||
{| class="wikitable" | |||
|- | |||
! Nazwa pola !! Opis !! Dodatkowe informacje | |||
|- | |||
| id || ID producenta || | |||
|- | |||
| nazwa || Nazwa producenta || | |||
|} | |||
<big>'''Eksport danych'''</big> | |||
'''1. Eksport produktów''' | |||
''Tab. 13. Żądanie'' | |||
{| class="wikitable" | |||
|- | |||
! Metoda !! URL | |||
|- | |||
| GET || /export/products | |||
|} | |||
''Tab. 14. Parametry żądania'' | |||
{| class="wikitable" | |||
|- | |||
! Typ !! Parametr !! Wartość | |||
|- | |||
| HEAD || X-ApiKey || string | |||
|} | |||
''Przykład użycia curl:'' | |||
curl -H 'X-ApiKey: klucz' -H "X-Token: token" -H -o nazwa_pliku | |||
https://nazwa_domeny/export/products | |||
'''Specyfikacja pliku z produktami''' | |||
Plik w formacie csv z następującą kolejnością pól: | |||
produkt_id,nazwa,kod_paskowy,producent_id,jednostka,gramatura_netto,opis | |||
Opis pól jest analogiczny do importowanych. | |||
Kolejne produkty oddzielone znakiem nowej linii | |||
Wersja z 11:17, 10 lis 2020
Uzyskanie tokenu
Przed wywołaniem akcji importu należy najpierw uzyskać token za pomocą metody api
https://domena.pl/backendApi/login
Przykład użycia curl:
curl -H "X-ApiKey: klucz" --data '{"username":"login"}' -X POST "https://domena.pl/backendApi/login
Odpowiedź powinna wyglądać następująco: {"token":"c55cf6ff713b22e353c2224e0063a37c02d87f62"}
Uzyskany token jest następnie użyty przy komunikacji z API.
Import danych
1. Zakładanie nowych lub aktualizacja istniejących towarów.
Tab. 1. Żądanie
| Metoda | URL |
|---|---|
| POST | /import/products |
Tab. 2. Parametry żądania
| Typ | Parametr | Wartość |
|---|---|---|
| HEAD | X-ApiKey | string |
Przykład użycia curl:
curl -F 'file=@/ścieżka/do/pliku' -H 'X-ApiKey: klucz' -H "X-Token: token" -H 'Content-Type: text/csv' https://nazwa_domeny/import/products
Specyfikacja pliku z produktami
Plik musi być w formacie csv z następującą kolejnością pól: produkt_id,nazwa,kod_paskowy,producent_id,jednostka,gramatura_netto,opis kolejne produkty muszą być oddzielone znakiem nowej linii
Tab. 3. Opis pól pliku z produktami
| Nazwa pola | Opis | Dodatkowe informacje |
|---|---|---|
| produkt_id | Identyfikator produktu w sklepie | |
| nazwa | Nazwa | |
| kod_paskowy | Kod_paskowy | |
| producent_id | Identyfikator producenta | Podane id musi istnieć w bazie producentów |
| jednostka | Identyfikator jednostki miary | Np. szt,kg,op |
| gramatura_netto | Waga w gramach bez opakowania | |
| opis | Opis produktu wyświetlany na stronie |
2. Tworzenie lub modyfikacja powiązań towarów ze sklepami.
Tab. 4. Żądanie
| Metoda | URL |
|---|---|
| POST | /import/productsShop |
Tab. 5. Parametry żądania
| Typ | Parametr | Wartość |
|---|---|---|
| HEAD | X-ApiKey | string |
Przykład użycia curl: curl -F 'file=@/ścieżka/do/pliku' -H 'X-ApiKey: klucz' -H "X-Token: token" -H 'Content-Type: text/csv' https://nazwa_domeny/import/productsShop
Specyfikacja pliku z powiązaniami produktów ze sklepami
Plik musi być w formacie csv z następującą kolejnością pól produkt_id,cena,nowosc,promocja,gazetka,reklama,stan kolejne powiązania muszą być oddzielone znakiem nowej linii
Tab. 6. Opis pól pliku z powiązaniami
| Nazwa Pola | Opis | Dodatkowe informacje |
|---|---|---|
| produkt_id | Identyfikator produktu z danego sklepu | |
| cena | Cena brutto wyrażona w groszach | |
| Czy dany towar jest nowością | Możliwe wartości: 0 lub 1 | |
| promocja | Czy dany towar jest w promocji | Możliwe wartości: 0 lub 1 |
| gazetka | Czy dany towar jest z aktualnej gazetki | Możliwe wartości: 0 lub 1 |
| reklama | Dodatkowe promowanie produktów w wynikach wyszukiwania | Możliwe wartości: 1 - 10 |
| stan | Liczba towaru na stanie | 1000 oznacza 1 sztukę lub 1 kilogram |
3. Tworzenie lub modyfikacja powiązań towarów ze sklepami.
Tab. 7. Żądanie
| Metoda | URL |
|---|---|
| POST | /import/categories |
Tab. 8. Parametry żądania
| Typ | Parametr | Wartość |
|---|---|---|
| HEAD | X-ApiKey | string |
Przykład użycia curl: curl -F 'file=@/ścieżka/do/pliku' -H 'X-ApiKey: klucz' -H "X-Token: token" -H 'Content-Type: text/csv' https://nazwa_domeny/import/categories
Specyfikacja pliku z kategoriami Plik musi być w formacie csv z następującą kolejnością pól id,nadrzedna_id,nazwa,opis kolejne kategorie muszą być oddzielone znakiem nowej linii
Tab. 9. Opis pól pliku z kategoriami
| Nazwa pola | opis | Dodatkowe informacje |
|---|---|---|
| id | Id kategorii | |
| nadrzedna_id | Id kategorii nadrzędnej (puste jeśli kategoria jest kategorią główną) | Podane id musi istnieć w bazie kategorii |
| nazwa | Nazwa kategorii | |
| opis | Opis kategorii |
4. Tworzenie lub modyfikacja producentów
Tab. 10. Żądanie
| Metoda | URL |
|---|---|
| POST | /import/brands |
Tab. 11. Parametry żądania
| Typ | Parametr | Wartość |
|---|---|---|
| HEAD | X-ApiKey | string |
Przykład użycia curl: curl -F 'file=@/ścieżka/do/pliku' -H 'X-ApiKey: klucz' -H "X-Token: token" -H 'Content-Type: text/csv' https://nazwa_domeny/import/brands
Specyfikacja pliku z producentami Plik musi być w formacie csv z następującą kolejnością pól id,nazwa kolejni producenci muszą być oddzieleni znakiem nowej linii
Tab. 12. Opis pól pliku z producentami
| Nazwa pola | Opis | Dodatkowe informacje |
|---|---|---|
| id | ID producenta | |
| nazwa | Nazwa producenta |
Eksport danych
1. Eksport produktów
Tab. 13. Żądanie
| Metoda | URL |
|---|---|
| GET | /export/products |
Tab. 14. Parametry żądania
| Typ | Parametr | Wartość |
|---|---|---|
| HEAD | X-ApiKey | string |
Przykład użycia curl: curl -H 'X-ApiKey: klucz' -H "X-Token: token" -H -o nazwa_pliku https://nazwa_domeny/export/products
Specyfikacja pliku z produktami Plik w formacie csv z następującą kolejnością pól: produkt_id,nazwa,kod_paskowy,producent_id,jednostka,gramatura_netto,opis Opis pól jest analogiczny do importowanych. Kolejne produkty oddzielone znakiem nowej linii