Configuration
Authentication
Most of the GoSquared API requires authentication credentials. Sometimes you'll only need an API Key, other times you might also need to specify the token for the project.
It depends on the function being used, but usually you'll need to specify the following parameters:
| Parameter | Description |
|---|---|
api_key | An API Key associated with your account. You can manage your API keys under the API Access section of your account settings |
site_token | The token for the project you are retrieving data for. You can find this by navigating to Settings > Current Project > General. |
API Key Scopes
When you create an API Key for your account, you can choose to grant it a set of scopes which indicate what permissions are associated with that API Key. Scopes restrict access for a particular API Key to specific sections of the API, and prevent applications from accessing, tracking or modifying data when they shouldn't.
The Ruby gem requires a valid api_key and project_token.
Options
| Option | Description | Type | Default |
|---|---|---|---|
| api_key | An API Key that's authorised to write_tracking. | String | undefined |
| project_token | The project token of the project to track data for. | String | undefined |
gs = Gosquared::RubyLibrary.new('demo','GSN-106863-S')