Setting up API access

The stub Connect API has two environments: production and test. Both environments use the same login details (email and password).

You can access the test environment with the following details: Test website address: https://test.stub.africa/ Test API endpoint: https://test.connect.stub.africa/ Test key format: sk_test_xxxxxxxxxxxxxxxxxxx

You can access the production environment with the following details: Production website address: https://stub.africa/ Production API endpoint: https://connect.stub.africa/ Production key format: sk_live_xxxxxxxxxxxxxxxxxxx

For production access and your appid please reach out to us.

Where to get your API key:

To get your test API key login into https://test.stub.africa/ using the login details you created in the introduction.

1. Log in to your stub account

2. Select More in the left side nav bar

3. Select Apps in the left side nav bar

4. You can now view and copy your API key

Integrations page on stub

Now test that your API Key works

Now that you have your API key make sure everything is working correctly by making a post request to the test API endpoint below. You can select any App ID that includes your business name.

post

Body

application/json

apikeystringRequired

appidstringRequired

Responses

200Success

No content

400Error

401Error

post

/api/verify/apikey

HTTPcURLJavaScriptPython

POST /api/verify/apikey HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 32

{
  "apikey": "text",
  "appid": "text"
}

No content

Winner winner: If you get a 200 OK you're ready to start using our API.