Authentication

The Super API authenticates requests with an API key pair sent with HTTP Basic authentication. The key endpoints themselves are the exception: you sign in with a one-time passcode to create your first key.

Base URLs

Environment	Base URL
Demo (QA)	`https://qa-super.mygigsters.com.au`
Production	`https://super.mygigsters.com.au`

Create an API key

Call Log in to request a one-time passcode.

Verify the passcode

Call Verify OTP to exchange the passcode for a JWT.

Create the key

Call Create API key with the JWT as a Bearer token and a friendly name for the key.

Response

{
  "apiUsername": "39534898-f44e-461e-99fb-c27f3bdd515b",
  "apiPassword": "YOUR_API_PASSWORD"
}

The apiPassword is shown only once. Store it securely. If you lose it, create a new API key.

Send credentials with every request

Use apiUsername as the username and apiPassword as the password. Most HTTP clients build the Basic header for you.

curl 'https://qa-super.mygigsters.com.au/v1/employees' \
  -u 'apiUsername:apiPassword'

const response = await fetch("https://qa-super.mygigsters.com.au/v1/employees", {
  method: "GET",
  headers: {
    Authorization: "Basic " + Buffer.from("apiUsername:apiPassword").toString("base64"),
  },
});

const data = await response.json();
console.log(data);

import requests

response = requests.get(
    "https://qa-super.mygigsters.com.au/v1/employees",
    auth=("apiUsername", "apiPassword"),
)

print(response.json())

require "net/http"
require "json"
require "uri"

uri = URI("https://qa-super.mygigsters.com.au/v1/employees")
request = Net::HTTP::Get.new(uri)
request.basic_auth("apiUsername", "apiPassword")

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
  http.request(request)
end

puts JSON.parse(response.body)

<?php

$ch = curl_init("https://qa-super.mygigsters.com.au/v1/employees");

curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_USERPWD => "apiUsername:apiPassword",
]);

$response = curl_exec($ch);
curl_close($ch);

print_r(json_decode($response, true));

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.util.Base64;

public class Example {
    public static void main(String[] args) throws Exception {
        String credentials = Base64.getEncoder()
            .encodeToString("apiUsername:apiPassword".getBytes());

        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://qa-super.mygigsters.com.au/v1/employees"))
            .header("Authorization", "Basic " + credentials)
            .method("GET", HttpRequest.BodyPublishers.noBody())
            .build();

        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());

        System.out.println(response.body());
    }
}

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	req, err := http.NewRequest("GET", "https://qa-super.mygigsters.com.au/v1/employees", nil)
	if err != nil {
		panic(err)
	}
	req.SetBasicAuth("apiUsername", "apiPassword")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	data, _ := io.ReadAll(res.Body)
	fmt.Println(string(data))
}

using System.Net.Http.Headers;
using System.Text;

using var client = new HttpClient();

var request = new HttpRequestMessage(HttpMethod.Get, "https://qa-super.mygigsters.com.au/v1/employees");
request.Headers.Authorization = new AuthenticationHeaderValue(
    "Basic", Convert.ToBase64String(Encoding.UTF8.GetBytes("apiUsername:apiPassword")));

var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

To build the header yourself, base64-encode apiUsername:apiPassword and send it as Authorization: Basic {encoded}.

Keep your keys safe

Never commit API keys to version control.
Store credentials in environment variables.
Rotate API keys regularly, and delete unused keys with Delete API key.
Use HTTPS for every request.

Get started

Guides

Base URLs

Create an API key

Send credentials with every request

Keep your keys safe

​Base URLs

​Create an API key

​Send credentials with every request

​Keep your keys safe

Base URLs

Create an API key

Send credentials with every request

Keep your keys safe