AUTOMATYZACJE

API – wersja produkcyjna

API umożliwiające sadzenie drzew i generowanie certyfikatów

Ważna uwaga: ta strona dotyczy API w wersji produkcyjnej. Dla potrzeb testów udostępniamy wersję testową. Więcej informacji tutaj: API Posadzimy.pl wersja do testów

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.

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.

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

sadzić drzewa za zakup biletu na Twoje wydarzenie,

sadzić drzewa automatycznie za co tylko chcesz, jak tylko chcesz!

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

Rejestracja i logowanie

Wejdź na stronę https://panel.posadzimy.pl/rejestracja i 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.

Zakup kredytów do sadzenia drzew

Aby sadzić drzewa przez API należy zakupić kredyty API.

Należy wybrać liczbę kredytów oraz sposób płatności. Zarówno w przypadku płatności przez PayU, jak i przelewem, po odnotowaniu wpłaty, faktura VAT zostanie wysłana na adres mailowy. Będzie można pobrać ją również z panelu klienta.

Wybór szablonu i treści nagłówka certyfikatu

Możemy tutaj wybrać szablon, który będzie domyślnie używany do generowania certyfikatów. Przykładowo możemy wybrać język angielski. Możemy też wskazać, co ma znajdować się w nagłówku certyfikatu.

Nazwa projektu – wartość podana jako “Nazwa firmy/projektu” w zakładce “Dane firmowe”.
Tekst podany przez API – dowolny tekst podawany przez API. Może być personalizowany.
Twoje logo (jeśli dodane) – logo dodane w zakładce „Dane firmowe”

Przy każdorazowym wywołaniu API możemy wskazać inny szablon certyfikatu (używając numeru ID szablonu, który znajduje się przy jego nazwie). W takim przypadku wskazany tutaj szablon zostanie nadpisany.

Dodatkowo, przy każdorazowym wysłaniu żą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!”

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.

Opcje personalizacji certyfikatu przy wywołaniu API

treeGroupID – ID sadzenia, do którego dodane zostaną drzewa. ID sadzenia znajduje się w panelu klienta w Posadzimy.pl
customTemplateID – ID szablonu certyfikatu. Jeśli nie prześlemy tego parametru, zostanie wybrany szablon wskazany w panelu klienta.
numberOfTrees – liczba posadzonych drzew. Jeśli nie prześlemy tego parametru, będzie to 1 drzewo.
customerName – tekst przekazywany do nagłówka certyfikatu, jeśli w panelu klienta jako nagłówek wskażemy tekst wysyłany przez API.
certificateText – dodatkowy tekst widoczny na certyfikacie.

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 drzewa.

Opcje personalizacji wiadomości

customText – tekst przekazywane do body wiadomości
linkToCertificate -link do certyfikatu, otrzymany po jego wygenerowaniu
numberOfTrees – liczba posadzonych drzew.
lang– szablon językowy maila. Obsługiwane języki: pl, de ,en. Domyślnie pl.

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.