INTEGRATIONS & API
Roster API
5 min
the roster api allows brands to build integrations that extend and enhance the roster experience you can find the roster api documentation https //api getroster com/docs/v2/index html you can also use our https //api getroster com/swagger in preparation for development, or download the openapi specification to use in postman or other openapi aware tools api access tokens all api endpoints require either a public or private access token it is critical that you never share a private access token with anybody who shouldn't have read/write access to all of your roster data this includes never using a private access token in a front end client, such as your brand's website or online store public access tokens public access tokens are intended to be used in public, insecure environments, such as a browser these token can only be used with two endpoints for capturing link clicks and orders refer to the api docs for details on these two endpoints private access tokens private access tokens provide read/write access to a significant amount of private account data as such, private access tokens should only be used in secure, trusted environments (e g server side) and should never be shared with anybody (including 3rd parties) with whom you wouldn't want to have read/write access to your roster data create and manage access tokens you can add, copy, and remove public and private access tokens from within your roster account access the integrations section in roster click on the brand logo located at the bottom of the window click on integrations > api integration create a new access token click the new access token button and select whether you want to create a public or a private access token click the copy icon next to the newly generated token to copy it to your clipboard expire an access token click the more menu for the access token you want to expire select expire token from the menu and confirm that you want to delete the token all roster accounts linked to a shopify store have a default public access token which cannot be expired as this is the token that is automatically added to your store's pages to track link clicks and referred orders need help? if you have any questions or need assistance, please reach out to our support team at mailto\ support\@getroster com