Ayrshare Docs
Ask or search…
⌃K
Links

User Integration

How to integrate with Ayrshare allowing your users, clients, or brands to link their social media accounts.

Integrate Your Platform with Ayrshare

Ayrshare operates as an API-centric platform, intended to function subtly in the background.
The only interaction your users will have with Ayrshare is through the social networks linking page. This process is designed to be smooth and effortless for your users, without requiring them to create an account or log in.
Ayrshare organizes each of your users into what we call a 'User Profile'. A User Profile can have one connection to each social network.

User Experience

Your users will authorize their social media accounts, such as Instagram or Facebook, to allow you to post, get analytics, etc. on their behalf via Ayrshare's API. Each "User Profile" can have one connection to each of the social networks.
  1. 1.
    Within your app, create a link or button, e.g. "Link Your Social Accounts", that your user will click to open the social linking page.
  2. 2.
    When the link is clicked, open a new browser tab, window, or webview with the URL returned from the /generateJWT endpoint.
  3. 3.
    The social linking page will show all the available networks, which you can control. In the upper left corner will be your branded logo. You can customize many aspects of this page such as the title, help link, and profile image.
  4. 4.
    Your user will choose the social networks they want to link and close the tab once complete by clicking the All Done button.
At the top of the page will be your branded logo.
From the user's perspective they are done and have successfully linked their social media accounts. With just a few clicks they will have their social media accounts linked and you'll be able to post on their behalf.
Behind the scenes, you'll create new profiles via the API or Dashboard, receive a Profile Key used to post on behalf of the users, and open the above Social Account linkage page by passing a JWT token to perform single sign on.
Please see the next pages on API Integration for Business on how to do this.

Page Customization

You can customize many portions of the social linkage page for either all users or specific users. Please see each section for details.
  • Add your own company logo or remove entirely. Please see the onboarding integration guide for details.
  • Select which social networks your users can access either universally or at the user profile level.
  • Remove links to help pages and add your own help pages.
  • Add or remove the profile image and logout for your users.
  • Set the top and sub headers on the social account linkage page. You can show your user's name, their business, another message, or remove entirely.
Business Plan customers can purchase the Max Pack for more customization options.
Enterprise Plan customers get advanced features such as customizing the CSS, languages, favicons, and more.
Last modified 4mo ago