Get started

API Endpoint

    https://api.rocketnet.co.za/api
                

The Gemini API provides programmatic access to read customer info and get services data. Retrieve a customer, and get service information.

To use this API, you need an API key as well as an API secret. If you are a customer, please contact us at [email protected] to request your API keys.

Authorization

Each API request shall be authenticated by means of an Authorization header using the Basic authentication method

The request should contain a header field in the form of Authorization: Basic <credentials>, where credentials is the base64 encoding of API key and API secret joined by a single colon :. See more information in wikipedia: https://en.wikipedia.org/wiki/Basic_access_authentication.

GET CUSTOMER

                    
# cURL example 
# Api Key: test_api_key
# Api Secret: test_api_secret
curl \
--location --request GET https://api.rocketnet.co.za/api/customer \
--header 'Authorization: Basic dGVzdF9hcGlfa2V5OnRlc3RfYXBpX3NlY3JldA==' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json'
                    
                    
Result example :

{
    "id": "9999",
    "login": "your@username",
    "category": "company",
    "name": "Company Name",
    "email": "[email protected]",
    "billing_email": "",
    "phone": "+27120000000",
    "street_1": "Address, Example",
    "zip_code": "0001",
    "city": "Johannesburg",
    "status": "active",
    "date_add": "1980-02-16",
    "gps": "",
    "street_2": "",
    "additional_attributes": {
        "company_name": "Company Example (Pty) Ltd",
    }  
}
                    
                

To get a customer you need to make a GET call to the following url :
https://api.rocketnet.co.za/api/customer

QUERY PARAMETERS

None

GET SERVICES

                    
# cURL example 
# Api Key: test_api_key
# Api Secret: test_api_secret
curl \
--location --request GET https://api.rocketnet.co.za/api/services \
--header 'Authorization: Basic dGVzdF9hcGlfa2V5OnRlc3RfYXBpX3NlY3JldA==' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json'
                    
                    
Result example :

[
  {
    "description": "Openserve:: Enterprise 100",
    "unit_price": "9999.0000",
    "start_date": "2024-02-16",
    "end_date": "0000-00-00",
    "discount": "0",
    "discount_value": "0.0000",
    "discount_type": "percent",
    "discount_start_date": "0000-00-00",
    "discount_end_date": "0000-00-00",
    "discount_text": "",
    "status": "active",
    "id": "1",
    "additional_attributes": {
      "rec_fno_id": "B1111xxxxx"
    }
  },
  {
    "description": "Openserve:: Enterprise 200",
    "unit_price": "9999.0000",
    "start_date": "2024-02-16",
    "end_date": "0000-00-00",
    "discount": "0",
    "discount_value": "0.0000",
    "discount_type": "percent",
    "discount_start_date": "0000-00-00",
    "discount_end_date": "0000-00-00",
    "discount_text": "",
    "status": "active",
    "id": "2",
    "additional_attributes": {
      "rec_fno_id": "B123xxxxxxx"
    }
  }
]
                    
                

To get ALL services for a customer you need to make a GET call to the following url :
https://api.rocketnet.co.za/api/services

QUERY PARAMETERS

None

GET SERVICE BY ID

                    
# cURL example 
# Api Key: test_api_key
# Api Secret: test_api_secret
curl \
--location --request GET https://api.rocketnet.co.za/api/services?id=2 \
--header 'Authorization: Basic dGVzdF9hcGlfa2V5OnRlc3RfYXBpX3NlY3JldA==' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json'
                    
                    
Result example :

{
    "description": "Openserve:: Enterprise 200",
    "unit_price": "9999.0000",
    "start_date": "2024-02-16",
    "end_date": "0000-00-00",
    "discount": "0",
    "discount_value": "0.0000",
    "discount_type": "percent",
    "discount_start_date": "0000-00-00",
    "discount_end_date": "0000-00-00",
    "discount_text": "",
    "status": "active",
    "id": "2",
    "additional_attributes": {
        "rec_fno_id": "B123xxxxxxx"
    }
}

                    
                

To get a specific service for a customer you need to make a GET call to the following url :
https://api.rocketnet.co.za/api/services?id=2

QUERY PARAMETERS

Field	Type	Description
id	String	The id of the service

Errors

The Gemini API uses the following error codes:

Error Code	Meaning
301	Authorization header request missing. You did not include the required headers in the request.
302	Unknown or invalid api_key or api_secret. This error appears if you use unknown API credentials or if your API credentials expired.
303	Some parameters are missing. This error appears when you don't pass every mandatory parameter.
400	Request method (GET/POST) is not allowed for that endpoint.
401	Invalid authorization data with upstream provider. Contact an Admin to assist.
404	Not Found. Results are empty or not found.