Specyfikacja plików w formacie CSV: Różnice pomiędzy wersjami

Z Pomoc Netis
m (UWAGA! Zastąpienie treści hasła bardzo krótkim tekstem: „'''<big>Uzyskanie tokenu</big>''' Przed wywołaniem akcji importu należy najpierw uzyskać token za pomocą metody api https:/...”)
Znacznik: Zastąpiono
mNie podano opisu zmian
Linia 5: Linia 5:
https://domena.pl/backendApi/login
https://domena.pl/backendApi/login


Przykład użycia curl:
''Przykład użycia curl:''


curl -H "X-ApiKey: klucz" --data '{"username":"login"}' -X POST
curl -H "X-ApiKey: klucz" --data '{"username":"login"}' -X POST
Linia 34: Linia 34:
|-
|-
| HEAD || X-ApiKey || string
| 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
{| class="wikitable"
|-
! 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 ||
|}
|}

Wersja z 10:32, 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

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