Linki do połączenia
Utwórz link, dzięki któremu klient połączy swoje konta społecznościowe z twoim obszarem roboczym bez logowania do AdaptlyPost, i unieważnij go, gdy skończysz.
Uprawnienie: accounts.manage. Zobacz Role i uprawnienia.
Tylko klucz Administratora ma accounts.manage, więc tylko klucze Administratora mogą tworzyć i unieważniać linki do połączenia.
Link do połączenia otwiera stronę, na której osoba bez konta w AdaptlyPost łączy swoje konta społecznościowe z twoim obszarem roboczym. Wyślij klientowi url, klient zatwierdza każdą platformę, a konta pojawiają się w Konta społecznościowe jak wszystkie inne.
POST /api/v1/connect-links
Każde pole jest opcjonalne. Bez treści żądania otrzymasz szybki link: oferuje wszystkie platformy, pokazuje klientowi wszystkie konta w obszarze roboczym, łączy dowolną liczbę kont i przestaje działać po 7 dniach.
| Pole | Typ | Opis |
|---|---|---|
name | string, do 80 znaków | Etykieta na liście linków w panelu. Widzi ją tylko twój zespół |
visibility | PUBLIC lub PRIVATE | PRIVATE pokazuje klientowi tylko konta połączone przez ten link. Domyślnie PUBLIC |
allowedPlatforms | tablica typów platform | Platformy, które klient może wybrać. Pomiń lub wyślij [], aby objąć wszystkie platformy |
maxAccounts | liczba całkowita, co najmniej 1 | Link przestaje działać, gdy połączy się przez niego tyle kont. Ponowne połączenie konta, które już przez niego połączono, nie liczy się drugi raz |
expiresAt | data i godzina ISO 8601 z Z lub przesunięciem | Moment, w którym link przestaje działać. Od 1 godziny do 365 dni od teraz. Domyślnie za 7 dni |
neverExpires | boolean | true utrzymuje link aktywny do czasu unieważnienia. Nie wysyłaj razem z expiresAt |
returnUrl | adres URL https, do 2048 znaków | Dokąd trafia klient po połączeniu konta, wyborze stron lub kanałów albo po odmowie, aby wrócić do twojej aplikacji. Musi to być https (http tylko dla localhost), bez nazwy użytkownika i hasła. Twoje własne parametry zapytania są zachowywane |
Przykładowe żądanie:
{
"name": "Acme onboarding",
"visibility": "PRIVATE",
"allowedPlatforms": ["INSTAGRAM", "TIKTOK"],
"maxAccounts": 3,
"expiresAt": "2026-11-30T18:00:00Z",
"returnUrl": "https://app.example.com/social/connected?client=42"
}Zwraca 201:
{
"url": "https://adaptlypost.com/connect/9f2c4e71b0d8...",
"token": "9f2c4e71b0d8...",
"expiresAt": "2026-11-30T18:00:00.000Z",
"name": "Acme onboarding",
"visibility": "PRIVATE",
"allowedPlatforms": ["INSTAGRAM", "TIKTOK"],
"maxAccounts": 3,
"returnUrl": "https://app.example.com/social/connected?client=42",
"startUrls": [
{ "platform": "INSTAGRAM", "url": "https://auth.adaptlypost.com/auth/connect/9f2c4e71b0d8.../INSTAGRAM/start" },
{ "platform": "TIKTOK", "url": "https://auth.adaptlypost.com/auth/connect/9f2c4e71b0d8.../TIKTOK/start" }
]
}| Pole | Opis |
|---|---|
url | Strona do wysłania. Każdy, kto ją ma, może łączyć konta z tym obszarem roboczym, dopóki link działa |
token | Identyfikuje link. Zachowaj go, aby później unieważnić link |
expiresAt | Moment, w którym link przestaje działać, lub null dla linku bez daty wygaśnięcia |
name, visibility, allowedPlatforms, maxAccounts | Ustawienia, z którymi utworzono link. name i maxAccounts mają wartość null, gdy ich nie ustawiono |
returnUrl | returnUrl, z którym utworzono link, lub null |
startUrls | Jeden obiekt { platform, url } na każdą oferowaną platformę, która łączy się przez własny ekran zgody serwisu. Bluesky i Telegram są pominięte, bo łączą się na stronie linku. Dodaj server do adresu Mastodona, site do adresu WordPressa i via=facebook do adresu Instagrama, aby połączyć Instagram przez stronę na Facebooku |
expiresAt spoza zakresu albo expiresAt wysłane razem z neverExpires zwraca 400 z komunikatem wskazującym przyczynę. returnUrl, który nie używa https albo zawiera nazwę użytkownika lub hasło, również zwraca 400.
Link przestaje działać także natychmiast po unieważnieniu, po połączeniu maxAccounts kont lub gdy osoba, która go utworzyła, nie może już zarządzać kontami w obszarze roboczym.
Własne przyciski połączenia
Wyślij returnUrl i umieść każdy wpis z startUrls pod przyciskiem w swojej aplikacji. Przycisk prowadzi klienta prosto na ekran zgody serwisu, z pominięciem strony linku. Po połączeniu, wyborze stron lub kanałów albo po odmowie klient trafia na returnUrl z dodanymi parametrami zapytania:
| Parametr | Opis |
|---|---|
status | connected lub error |
platform | Typ platformy, jeśli jest znany |
accountId | Po jednym na każde dodane konto, to samo id, które podaje Konta społecznościowe. Wybór stron lub kanałów może dodać kilka |
error | W razie błędu kod, na przykład cancelled, gdy klient zamknął okno wyboru |
message | W razie błędu tekst, który możesz pokazać klientowi, jeśli jest dostępny |
Błędne hasło do Bluesky lub WordPressa zatrzymuje klienta na stronie linku, aby mógł spróbować ponownie.
DELETE /api/v1/connect-links/:token
Natychmiast unieważnia link. Konta już przez niego połączone pozostają połączone. Zwraca { "success": true } lub 404, gdy żaden link w tym obszarze roboczym nie ma takiego tokenu.