sadzenie przez API - wersja testowa

Ważna uwaga: ta strona dotyczy API w wersji testowej. Należy pamiętać, że wersja produkcyjna to osobna aplikacja - dotyczy to panelu klienta i API. Po udanych testach należy zmienić linki do API, założyć osobne konto na wersji produkcyjnej, i wygenerować tam nowe dane do połączenia.

API Posadzimy.pl - jak to działa?

API - jak lubimy o nim mówić - to morze możliwości! Dlaczego? Bo jeśli zintegrujesz swoją stronę z panelem Posadzimy.pl możesz automatycznie generować certyfikaty jak tylko chcesz, za co tylko chcesz!

Co możesz zrobić dzięki API?

automatycznie sadzić drzewa za każdą rejestrację, podpisanie umowy, zgodę marketingową,
sadzić drzewa za określone zachowania użytkowników Twojej strony, np. za zakupy określonej grupy produktów, dodanie wybranej rzeczy do koszyka zakupowego itp.,
sadzić drzewa za zakup biletu na Twoje wydarzenie,
sadzić drzewa automatycznie za co tylko chcesz, jak tylko chcesz!

API (Application Programming Interface) to Interfejs Programowania Aplikacji, który pozwala na szybką i prostą integrację różnych aplikacji/serwisów, poprzez przygotowane endpointy, czyli punkty dostępu. Integrując system posadzimy ze swoją stroną poprzez API możesz sadzić drzewa jak tylko chcesz - za każde działanie wykonane na Twojej stronie, a całość odbywa się automatycznie. Aby zintegrować się przez API potrzebna jest podstawowa wiedza programistyczna. Do API można połączyć się przez różne języki programistyczne - niezależnie od języka API.

Rozważasz integrację poprzez API, ale masz wątpliwości, pytania, lub potrzebujesz pomocy? Jesteśmy tu dla Ciebie! Skontaktuj się z nami, umówmy się na spotkanie online - we wszystkim Ci pomożemy - kontakt@posadzimy.pl

Przygotowanie do integracji testowej po stronie panelu klienta

Rejestracja w serwisie

Wejdź na stronę https://rc.panel.posadzimy.pl/rejestracjai zarejestruj się, uzupełniając odpowiednie pola. Jeśli jesteś zarejestrowany, przejdź do logowania.

Logowanie i włączenie możliwości Sadzenia przez API

Po prawidłowej rejestracji zostaniesz automatycznie zalogowany i przekierowany do panelu klienta. Dodaj dane Twojej firmy i zatwierdź przyciskiem "Zaktualizuj".

Przejdź do zakładki "Sadzenie przez API" lub kliknij w przycisk "Dowiedz się więcej i aktywuj API".

Naciśnij przycisk “Uruchom sadzenie przez API”

Sadzenie przez API jest aktywne.

W wersji testowej zostało dodane 1000 kredytów API automatycznie - w wersji produkcyjnej należy te kredyty zakupić.

Najważniejsze dane w panelu API:

Liczba dostępnych kredytów API

Klucz API - pozwala połączyć się z kontem w Posadzimy.pl

Lista sadzeń wraz z ID sadzenia - pozwala wskazać, do którego sadzenia posadzić drzewo przez API

Ustawienia generowanego certyfikatu - więcej informacji poniżej

Dane z punktu 2 i 3 należy przekazać do osób odpowiedzialnych technicznie za integrację z API.

Możliwości integracji z Posadzimy.pl

Posadzenie wskazanej liczby drzew oraz wygenerowanie certyfikatu pdf

endpoint: /api/integration/make_order

Drzewa dodawane są do sadzenia firmowego i wyświetlają się na stronie firmy.
Na podstawie wysłanych przez API danych, generowany jest certyfikat posadzenia drzew.

Uwaga!
Sadzenie odbywa się w oparciu o zakupione kredyty. Jeśli w panelu klienta nie posiadamy wystarczającej liczby kredytów, sadzenie nie zostanie wykonane.

Opcje personalizacji certyfiaktu:

Wybór szablonu certyfikatu - wybrany szablon będzie domyślnie używany przy sadzeniu drzewa przez API. Istnieje możliwość wskazania szablonu każdorazowo przy wysyłaniu żądnia do API. Należy podać wtedy ID szablonu, widoczne w nawiasie.
Wybór nagłówka certyfikatu:
- Nazwa projektu - wartość podana jako "Nazwa firmy / projektu" w zakładce "Dane firmowe". Jeśli ta opcja zostanie wybrana to nagłówek będzie zawierał tę wartość, niezależnie od parametrów przesłanego żądania do API
- Tekst podany przez API - tekstowa wartość podawana każdorazowo przy wysyłaniu żądania do API
- Twoje logo (jeśli dodane) - logo dodane w zakładce "Dane firmowe"

Dodatkowo, przy każdorazowym wysłaniem żądania do API można też przesłać dodatkowy tekst, który będzie widoczny na certyfikacie. Przykładowo: "W podziękowaniu za współpracę posadziliśmy drzewo!"

Przykładowe certfiakty:

certyfikat z nagłówkiem tekstowym

certyfikat z logo firmy

Wygenerowanie gotowej wiadomości e-mail, która może zostać wysłana do klienta

endpoint: /api/integration/customer_mail_content

Endpoint zwraca wiadomość e-mail w formacie HTML z informacją o posadzeniu. Gotową wiadomość można wysłać do klienta samodzielnie, używając własnych serwerów pocztowych. Do wiadomości możemy dodać własny tekst.

Pobranie informacji o liczbie kredytów

endpoint: /api/integration/check_credit_balance

Endpoint ten zwraca dostępną liczbę kredytów.

Pobranie statystyk sadzeń firmy

endpoint: /api/integration/company_stats

Endpoint ten pozwala na pobranie aktualnej liczby posadzonych drzew, wraz z informacjami dodatkowymi. Dane te można użyć do własnej prezentacji danych o sadzeniu firmy np. na stronie firmowej.

Przepięcie integracji z wersji testowej na produkcyjną Posadzimy.pl

Po udanym połączeniu i przetestowaniu połączenia z API, należy przepiąć integrację na wersję produkcyjną.
Więcej informacji tutaj: Sadzenie przez API - wersja produkcyjna

Pomoc i kontakt w sprawie integracji przez API

Aby uzyskać pomoc w konfiguracji połączenia z API, prosimy o kontakt mailowy:
g.liputa@posadzimy.pl

API Posadzimy.pl[wersja do testów]