The Gigapipe Client uses API keys to authenticate requests. You can view and manage your API keys on the Gigapipe Dashboard.
The secret key has the prefix gigapipe_sk whereas the public one starts with gigapipe_pk. When used together, they provide users with the authentication token they need to make requests against the API or use the Gigapipe Client SDK. Alternatively, users can use their email and password to get the authorization authentication .
Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.
Authentication to the API is performed via HTTP Basic Auth. Provide your API key as the basic auth value.
Create your API Client SDK
The Gigapipe Client should be created on the Gigapipe Dashboard. When adding a new app, two things will happen:
- The organization will get a Client ID in case it does not have one yet.
- The user will get a Secret key.
As it can easily be noticed, all the users inside the organization will share the Client ID, whilst the Secret key is individual for each user.
Get the authorization token
Obtain the authorization token that will allow you to make requests to the API
curl -X 'GET' \
-H 'accept: application/json' \
-H 'client-id: <your_client_id>' \
-H 'client-secret: <your_client_secret>'
# Payload response
Use the access token to make calls against the API
pip install -u gigapipe
# Add your client secret key to the library
gigapipe.client_secret = "your_client_secret"
# Create an instance using your client id
gigapipe_client = gigapipe.GigapipeClient(client_id="your_client_id")