REST APIGET

API profili użytkowników mediów społecznościowych

Pobierz wszystkie konta społecznościowe połączone z obszarem roboczym AdaptlyPost wraz z platformą, identyfikatorem i statusem połączenia.

GEThttps://post.adaptlypost.com/post/api/v1/social-accounts

Zwraca listę wszystkich kont społecznościowych połączonych z obszarem roboczym. Zwrócone identyfikatory połączeń służą do tworzenia postów.

Klucz API (token Bearer)
Uprawnienie:accounts.readRole i uprawnienia

Użycie

Wartości id z tej odpowiedzi należy podawać jako identyfikatory połączeń przy tworzeniu postów. Każde konto zawiera displayName, username i avatarUrl. Konta stron na Facebooku mają także pageId (ID strony na Facebooku), ponieważ strony nie mają nazwy użytkownika. Dla Facebooka pageIds przyjmuje id konta lub pageId, a odpowiedzi dotyczące postów zawsze zwracają pageId. Każde konto ma też status: active albo unauthorized, gdy platforma odrzuciła jego token. Posty na konto unauthorized są odrzucane błędem 400 do czasu ponownego połączenia w panelu, a unauthorizedReason zawiera komunikat platformy.

Lokalizacja Google Business Profile ma tytuł lokalizacji jako displayName i pusty username. Konta Instagram mają pole supportsInstagramAudio, które ma wartość true, gdy konto połączono przez Facebooka, co jest wymagane do dodania dźwięku do Reela. Kanał lub grupa na Telegramie ma tytuł czatu jako displayName, publiczną @nazwę bez @ jako username (pustą, jeśli czat jej nie ma) i pusty avatarUrl. Czat, z którego usunięto bota AdaptlyPost, ma status unauthorized. Witryna WordPress, której dane logowania przestały działać (zwraca 401 lub 403), ma status unauthorized do czasu ponownego połączenia.

Ponowne sprawdzenie konta

POSThttps://post.adaptlypost.com/post/api/v1/social-accounts/:id/check

Strony są automatycznie sprawdzane na Facebooku dwa razy dziennie. Aby sprawdzić stronę od razu, należy wywołać ten endpoint z id konta lub pageId. Odrzucony token oznacza stronę jako unauthorized i wywołuje account.unauthorized; działający token usuwa wcześniejsze oznaczenie. Odpowiedź zawiera aktualny status.

Klucz API (token Bearer)
Uprawnienie:accounts.manageRole i uprawnienia

Uprawnienie accounts.manage ma tylko klucz Administratora. Łączenie, odłączanie i ponowne sprawdzanie kont, wybór stron i tablic, preferencje Pinteresta i linki do połączenia są dostępne wyłącznie dla Administratora.

Usunięcie konta

DELETEhttps://post.adaptlypost.com/post/api/v1/social-accounts/:id

Odłącza konto od obszaru roboczego, tak samo jak odłączenie na stronie Łączniki. Zapisane tokeny są usuwane, konto znika ze wszystkich oczekujących i cyklicznych postów i przestaje wliczać się do planu. Należy podać id konta lub pageId. Działa niezależnie od statusu konta, więc konto unauthorized można usunąć bez ponownego łączenia. Odpowiedź zwraca id, platform, displayName oraz, dla Facebooka, pageId usuniętego konta wraz z removed: true. Id spoza obszaru roboczego zwraca 404.

Klucz API (token Bearer)
Uprawnienie:accounts.manageRole i uprawnienia

Uprawnienie accounts.manage ma tylko klucz Administratora. Łączenie, odłączanie i ponowne sprawdzanie kont, wybór stron i tablic, preferencje Pinteresta i linki do połączenia są dostępne wyłącznie dla Administratora.

W przypadku Facebooka usuwana jest tylko wskazana strona; pozostałe strony połączone tym samym logowaniem zostają. Usunięcie kanału YouTube wyłącza też jego zapasowe przesyłanie. Usunięcie kanału lub grupy na Telegramie kończy publikowanie, ale bot pozostaje na czacie, dopóki nie zostanie usunięty w Telegramie. Aby przywrócić konto, należy połączyć je ponownie.

Wyszukiwanie dźwięków na Instagramie

GEThttps://post.adaptlypost.com/post/api/v1/social-accounts/:id/instagram-audio

Wyszukuje muzykę i oryginalne dźwięki z Instagrama do dodania do Reela. Bez searchQuery zwraca popularne pozycje. Wybrane audioId należy przekazać w instagramConfigs[].audio. Działa tylko dla kont Instagram z supportsInstagramAudio: true.

Klucz API (token Bearer)
Uprawnienie:posts.draftRole i uprawnienia

Parametry zapytania

ParametrTypOpis
audioTypeWYMAGANEstringmusic lub original_sound
searchQuerystringFiltr słów kluczowych, do 100 znaków. Pominięcie zwraca popularne dźwięki

Pola dźwięku

PoleOpis
audioIdNależy przekazać jako instagramConfigs[].audio.audioId
audioTypemusic lub original_sound
titleTytuł utworu
displayArtist, igUsernamedisplayArtist dla muzyki, igUsername (nazwa twórcy na Instagramie) dla oryginalnego dźwięku
durationMsDługość w milisekundach
coverArtworkUrl, profilePictureUrlOkładka dla muzyki, zdjęcie profilowe twórcy dla oryginalnego dźwięku
previewUrlTymczasowy link do pliku audio do odsłuchu. Wygasa po około 1,5 dnia
instagramUrlStrona dźwięku na Instagramie
isAdsEligibleCzy Instagram oznacza dźwięk jako dostępny do użycia w reklamach
Lista zawiera wyłącznie dźwięki dopuszczone przez Meta do publikacji z innych aplikacji, więc może się różnić od tego, co pokazuje aplikacja Instagram. Konto niepołączone przez Facebooka lub wyszukiwanie odrzucone przez Instagram zwraca 400. Nieznane id konta zwraca 404.

Lista tablic Pinterest

GEThttps://post.adaptlypost.com/post/api/v1/social-accounts/:id/pinterest-boards

Zwraca w boards wszystkie tablice, na które konto Pinterest może przypinać, także tajne. Należy przekazać id tablicy jako pinterestConfigs[].boardId lub jej nazwę jako pinterestConfigs[].boardName. Tablica należy do jednego konta Pinterest, dlatego listę trzeba pobrać dla każdego konta, na które trafia post.

Klucz API (token Bearer)
Uprawnienie:posts.draftRole i uprawnienia

Pola tablicy

PoleOpis
idNależy przekazać jako pinterestConfigs[].boardId
nameNazwa tablicy. Można ją przekazać jako pinterestConfigs[].boardName
descriptionOpis tablicy. Opcjonalne
privacyPUBLIC, PROTECTED lub SECRET, zgodnie z danymi Pinteresta. Opcjonalne
pinCountLiczba pinów na tablicy. Opcjonalne
Id konta, które nie istnieje lub nie jest kontem Pinterest w tym obszarze roboczym, zwraca 404. Żądanie odrzucone przez Pinterest zwraca 400, zwykle dlatego, że konto wymaga ponownego połączenia.

Lista kategorii WordPress

GEThttps://post.adaptlypost.com/post/api/v1/social-accounts/:id/wordpress-categories

Zwraca w categories kategorie witryny WordPress posortowane według nazwy. Id kategorii należy przekazać w wordpressConfigs[].categoryIds. Endpoint pozwala zamienić znane nazwy kategorii na id. Kategoria należy do jednej witryny, dlatego listę trzeba pobrać dla każdej witryny, na której publikowany jest post.

Klucz API (token Bearer)
Uprawnienie:posts.draftRole i uprawnienia

Pola kategorii

PoleOpis
idNależy przekazać w wordpressConfigs[].categoryIds
nameNazwa kategorii
parentIdId kategorii nadrzędnej lub null dla kategorii najwyższego poziomu
Id konta, które nie istnieje lub nie jest kontem WordPress w tym obszarze roboczym, zwraca 404. Witryna odrzucająca żądanie zwraca błąd 4xx, a niedostępna witryna 502. Komunikat wyjaśnia przyczynę.

Wyszukiwanie strony firmowej na LinkedIn

GEThttps://post.adaptlypost.com/post/api/v1/linkedin-organizations/lookup

Zwraca w organization stronę firmową na LinkedIn wraz ze wzmianką gotową do wklejenia w treść posta na LinkedIn. Należy podać adres URL strony, jej nazwę własną (część po linkedin.com/company/) lub nazwę własną z @.

Klucz API (token Bearer)
Uprawnienie:accounts.readRole i uprawnienia

Parametry zapytania

ParametrTypOpis
queryWYMAGANEstringAdres URL strony firmowej, np. https://www.linkedin.com/company/acme/, jej nazwa własna (acme) lub @acme. Od 1 do 300 znaków

Pola organizacji

PoleOpis
idID organizacji na LinkedIn
nameNazwa strony wyświetlana na LinkedIn
vanityNameNazwa własna z adresu URL strony. Może mieć wartość null
urnURN organizacji, urn:li:organization:<id>
mentionNależy wkleić do treści posta na LinkedIn bez zmian

LinkedIn dopasowuje wyłącznie dokładną nazwę własną, więc nie jest to wyszukiwanie: acm lub nazwa ze spacjami niczego nie znajdą. Gdy post trafia też na inne platformy, wzmiankę należy umieścić w platformTexts dla LINKEDIN, ponieważ inne platformy pokażą tę składnię jako zwykły tekst.

Zapytanie niebędące adresem URL strony ani nazwą własną zwraca 400 z kodem linkedin_organization_query_invalid. Nazwa własna, której nie ma żadna strona, zwraca 404 z kodem linkedin_organization_not_found. Gdy żadne konto LinkedIn w obszarze roboczym nie może wykonać wyszukiwania, zwracane jest 400 z kodem linkedin_organization_lookup_unavailable: należy połączyć lub ponownie połączyć konto LinkedIn, najlepiej stronę firmową, którą się administruje.
Lista wszystkich integracji
curl --request GET \
  --url https://post.adaptlypost.com/post/api/v1/social-accounts \
  --header 'Authorization: Bearer <api-key>'
Natychmiastowe sprawdzenie strony na Facebooku
curl --request POST \
  --url https://post.adaptlypost.com/post/api/v1/social-accounts/<account-id>/check \
  --header 'Authorization: Bearer <api-key>'
Usunięcie konta
curl --request DELETE \
  --url https://post.adaptlypost.com/post/api/v1/social-accounts/<account-id> \
  --header 'Authorization: Bearer <api-key>'
Wyszukiwanie dźwięków na Instagramie
curl --request GET \
  --url 'https://post.adaptlypost.com/post/api/v1/social-accounts/<account-id>/instagram-audio?audioType=music&searchQuery=summer' \
  --header 'Authorization: Bearer <api-key>'
Lista tablic Pinterest
curl --request GET \
  --url https://post.adaptlypost.com/post/api/v1/social-accounts/<account-id>/pinterest-boards \
  --header 'Authorization: Bearer <api-key>'
Lista kategorii WordPress
curl --request GET \
  --url https://post.adaptlypost.com/post/api/v1/social-accounts/<account-id>/wordpress-categories \
  --header 'Authorization: Bearer <api-key>'
Wyszukiwanie strony firmowej na LinkedIn
curl --request GET \
  --url 'https://post.adaptlypost.com/post/api/v1/linkedin-organizations/lookup?query=devtestco' \
  --header 'Authorization: Bearer <api-key>'
200
{
  "accounts": [
    {
      "id": "conn_abc123",
      "platform": "TWITTER",
      "displayName": "Your Handle",
      "username": "@yourhandle",
      "avatarUrl": "https://pbs.twimg.com/profile_images/...",
      "status": "active"
    },
    {
      "id": "conn_def456",
      "platform": "LINKEDIN",
      "displayName": "Your Company",
      "username": "",
      "avatarUrl": "https://media.licdn.com/...",
      "status": "active"
    },
    {
      "id": "conn_ghi789",
      "platform": "INSTAGRAM",
      "displayName": "Your Profile",
      "username": "yourprofile",
      "avatarUrl": "https://scontent.cdninstagram.com/...",
      "status": "active",
      "supportsInstagramAudio": true
    },
    {
      "id": "conn_pqr678",
      "platform": "TELEGRAM",
      "displayName": "Your Channel",
      "username": "yourchannel",
      "avatarUrl": "",
      "status": "active"
    },
    {
      "id": "conn_mno345",
      "platform": "GOOGLE_BUSINESS",
      "displayName": "Your Cafe, Main Street",
      "username": "",
      "avatarUrl": "",
      "status": "active"
    },
    {
      "id": "conn_jkl012",
      "platform": "FACEBOOK",
      "displayName": "Your Page",
      "username": "",
      "avatarUrl": "",
      "status": "unauthorized",
      "unauthorizedReason": "This Page access token belongs to a Page that is not accessible.",
      "pageId": "123456789012345"
    }
  ]
}