Jak dodać ofertę do Vereel przez API

Jeśli Twój zespół pracuje na arkuszu, pliku z produktami albo w narzędziu agencji, najwolniejsze jest ręczne wpisywanie każdej kampanii do formularza. API Vereel pozwala wysyłać ofertę prosto z tych narzędzi. Oto cała droga, od utworzenia tokena do kampanii na stronie, razem z tym, co zaskakuje najbardziej: każda oferta jest weryfikowana, zanim stanie się publiczna.
Co można zrobić przez API
API ma dwie strony. Przeglądanie jest otwarte: każdy może wyświetlić publiczne oferty Vereel i otworzyć szczegóły jednej z nich, z tymi samymi informacjami, które widzi odwiedzający stronę, bez kwot. Zapis jest dla marek: tokenem z ustawień możesz utworzyć ofertę, zmieniać ją w trakcie weryfikacji, dodawać zdjęcia i sprawdzać status wszystkiego, co przez API wysłano.
Na tym świadomie się kończy. API nie opublikuje oferty, nie usunie jej, nie rozpocznie kampanii i nie przeniesie pieniędzy. Te kroki zostają w aplikacji, gdzie działają już warunki i kontrole płatności.
Krok 1: utwórz token
Zaloguj się jako marka i otwórz Ustawienia › Tokeny API. Nazwij token od tego, co będzie go używać („Skrypt agencji”, „Feed sklepu”), wybierz odczyt i zapis, jeśli ma tworzyć oferty, i ustal, jak długo ma działać: 30, 90 albo 365 dni. Zaznacz Warunki Współpracy dla ofert, które będzie wysyłał, bo każda oferta wysłana tym tokenem niesie tę akceptację.
Skopiuj token w chwili, gdy się pojawi. Vereel zachowuje tylko jego skrót, więc nie da się go pokazać ponownie; jeśli go zgubisz, unieważnij go i utwórz nowy. Traktuj go jak hasło: trzymaj na serwerze albo w sekretach swojego narzędzia, nigdy na stronie internetowej ani w publicznym repozytorium.
Krok 2: wyślij pierwszą ofertę
Najpierw wybierz kategorię: GET https://www.vereel.com/api/v1/public/categories zwraca listę z identyfikatorami. Potem wyślij ofertę. Poniższe zapytanie wystarczy na początek; podmień tekst, identyfikator kategorii i adres zdjęcia na własne.
curl -X POST https://www.vereel.com/api/v1/public/my/offers \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"name": "Autumn skincare set",
"description": "Show how our vitamin C serum fits into your morning routine: one Reel and two Stories.",
"offerType": "PRODUCT",
"platforms": ["instagram"],
"categoryIds": ["00000000-0000-0000-0000-000000000001"],
"isPayment": false,
"isBarter": true,
"productServiceValue": 150,
"currency": "PLN",
"includedDescription": "One 30 ml bottle of the serum, shipped to you before you start.",
"imageUrls": ["https://example.com/serum.jpg"]
}'Co wraca w odpowiedzi
Udane wywołanie zwraca 201 z identyfikatorem oferty i statusem in_review. Gdy coś jest nie tak, odpowiedź to 422, a pole details wskazuje każde błędne pole, na przykład kategorię, która nie istnieje.
Krok 3: dodaj zdjęcie
Oferta potrzebuje co najmniej jednego zdjęcia, zanim zostanie zatwierdzona. Najprościej podać imageUrls, jak wyżej: Vereel pobiera obraz samodzielnie. Adres musi być https na publicznym serwerze, a plik to JPEG, PNG lub WebP do 5 MB. Vereel sprawdza zawartość pliku, nie jego nazwę.
Jeśli zdjęcie nie jest jeszcze gotowe, dodaj je później przez adres zdjęć oferty: wyślij {"url": …} albo poproś o adres do wgrania, wgraj plik i w ciągu 15 minut dołącz zwróconą ścieżkę. Oferta może mieć do sześciu zdjęć, a pierwsze jest okładką.
Krok 4: obserwuj weryfikację
Każda oferta wysłana przez API czeka w kolejce weryfikacji. Osoba z Vereel ją ogląda i zatwierdza albo zwraca do Twoich wersji roboczych z uzasadnieniem. W obu przypadkach dostajesz informację, w aplikacji i e-mailem. Do tego czasu oferta nie jest publiczna, a Ty możesz ją dalej edytować. Status pokaże GET /my/offers/{id}: in_review, active, rejected (z uwagą recenzenta) albo closed.
Po zatwierdzeniu oferta działa jak utworzona w kreatorze: twórcy mogą się zgłaszać, a zgłoszeniami zajmujesz się w aplikacji.
Limity, o których warto wiedzieć
Kilka zasad chroni Ciebie i Vereel przed lawiną przypadkowych zapytań:
- Treść zapytania ma co najwyżej 64 KB.
- Naraz możesz mieć do 20 ofert w weryfikacji i wysłać do 50 nowych ofert z API na dobę.
- Jeden token może wykonać do 30 zmian w ciągu 10 minut.
- Gdy Warunki Współpracy się zmienią, zaakceptuj je ponownie w Ustawieniach › Tokeny API: do tego czasu token może odczytywać, ale nie może tworzyć ofert.
Strona API zawiera pełny opis, z każdym polem i kodem błędu, a plik OpenAPI pozwala Twoim narzędziom wygenerować klienta.
Najczęstsze pytania
- Czy każdy może dodawać oferty przez API?
- Nie. Zapis wymaga tokena utworzonego na koncie marki. Przeglądanie publicznych ofert nie wymaga tokena.
- Czy oferta pojawi się od razu?
- Nie. Każda oferta wysłana przez API jest najpierw weryfikowana przez Vereel. Powstaje ze statusem in_review i trafia na stronę dopiero po zatwierdzeniu.
- Czy przez API mogę publikować, usuwać lub płacić?
- Nie. API tworzy i edytuje oferty w weryfikacji oraz dodaje zdjęcia. Publikacja po zatwierdzeniu, rozpoczęcie kampanii i płatności odbywają się w aplikacji.
- Gdzie trzymać token?
- Na serwerze albo w sekretach swojego narzędzia. Nigdy na stronie internetowej, w aplikacji mobilnej ani w publicznym repozytorium. Jeśli wycieknie, unieważnij go w Ustawieniach › Tokeny API i utwórz nowy.