Setting up Bright Sites Web Services/API
Last updated: 1/29/2019
This document describes how to setup REST/JSON web services in Bright Sites. Please note any questions on how to code REST/JSON will not be supported (we can only answer questions directly related to our API). Pricing information for APIs, can be viewed here.
1. First you need to enable API access for your store. On the store dashboard, under basic store add-ons (API requires no less than a basic store!) turn on the api switch and accept the terms of the API:
2. Once the api is enabled, you can now click the link to access the API token setup:
3. Each call requires an authentication token, which must be generated in the store administrative area.
a. Once api has been turned on, visit the api page in the store administrative area (step #2)
b. Then, generate a new token (api key) by clicking on create new API key
c. Your new API key will appear in the modal window that is generated and this is the ONLY time the key will be shown, you’ll want to make sure to record that information in a safe place.
d. To set an expiration date for when the API key expires, click into the column under Expires and a date selector will appear.
You can modify the expiration date for an existing key by clicking on the same field.
NOTE: When you communicate the API key to your programmers we recommend doing so in a secure fashion, as well as using permissions to limit what the API key’s access. The API key is a password to your store’s administrative area!
4. You can also permission API keys to be “READ Only” or “Read/Write” and this means that an API key can either only return information queried (Read only) or return and update information to the system (Read/Write). API keys that were created prior to 2/5/2019 will default to having full access. API keys created after this date default to Read only access.
If permissions ARE NOT activated for the store, by default, the API token will have full READ/WRITE access. If permissions ARE activated for the store, the default access for the token is READ ONLY.
5. Example Call (please see API guide for more examples and endpoint listing):
Request is the store URL combined with the resource URL. The token is added to the end of the request with ?token=<token>. The request may contain JSON information (such as when updating an order). The resource URL may contain the ID of a resource (such as an address, order, or inventory unit). Please see the API guide for more information on the types of requests that can be made.
Response is the data returned from the system in JSON format.
6. To see a full list of API endpoints, examples, and more, please visit the api guide at: https://docs.mybrightsites.com/#introduction
7. Questions about how to use the API must be sent to firstname.lastname@example.org – please do not use our general support channels.