Cornvilla
Wypróbuj
Baza wiedzy

Integracje

API — podłączenie własnego systemu (Client ID i Client Secret)

Jak dodać aplikację API w panelu, jakie uprawnienia nadać, co zrobić z Client Secret i gdzie jest dokumentacja dla programistów.

2 min czytania

Cornvilla ma REST API: Twój program (ERP, sklep, własna aplikacja) może czytać i zmieniać zamówienia, produkty, stany, przesyłki i zwroty. API jest w cenie każdego pakietu, także w okresie próbnym. Logowanie działa jak w Apilo czy Allegro: aplikacja dostaje Client ID i Client Secret. Dokumentacja dla programisty: cornvilla.com/developers.

Krok 1. Dodaj aplikację

Ustawienia → API → Dodaj aplikację (tylko administrator).

  1. Nazwa — który system będzie się łączył, np. „ERP”. Każdy system powinien mieć własną aplikację: gdy coś pójdzie nie tak, odcinasz jedną, a reszta działa.
  2. Uprawnienia — w tabeli zaznacz odczyt i zapis dla zamówień, produktów, stanów, przesyłek, zwrotów i magazynu. Zaznaczaj tylko to, czego integracja naprawdę potrzebuje.
  3. Dodaj — pojawi się okno z Client ID i Client Secret.

Client Secret widać tylko raz. Skopiuj go od razu do integracji albo przekaż programiście bezpieczną drogą. Później możesz jedynie wygenerować nowy.

Krok 2. Przekaż dane programiście

Programista potrzebuje: Client ID, Client Secret i dokumentacji cornvilla.com/developers. Adres API i adres tokenu widać na górze strony Ustawienia → API.

Nowy Client Secret

Zgubiony albo ujawniony secret: na liście aplikacji kliknij ⋯ → Nowy Client Secret. Stary secret przestaje działać od razu, a nowy zobaczysz raz — trzeba go wpisać w integracji.

Zmiana uprawnień i usunięcie

  • ⋯ → Edytuj zmienia nazwę i uprawnienia. Integracja dostanie nowe uprawnienia przy następnym pobraniu tokenu (najpóźniej po godzinie).
  • ⋯ → Usuń odcina dostęp od razu. Tego nie da się cofnąć.
  • Kolumna Ostatnie użycie pokazuje, czy integracja nadal się łączy.

Bezpieczeństwo

  • Client Secret trzymaj po stronie serwera. Nigdy w kodzie strony www, w aplikacji mobilnej ani w publicznym repozytorium.
  • Uprawnienie Przesyłki — odczyt daje dostęp do adresów odbiorców (dane osobowe). Nadawaj je tylko systemom, które naprawdę nadają paczki.
  • Gdy integracja przestaje być używana albo ktoś z dostępem do niej odchodzi z firmy, usuń aplikację albo wygeneruj nowy secret.