Introduction

Authentication

Wafeq supports authentication via two methods,

  • Private Key (recommended for accessing your own organization by your application)
  • OAuth Flow (recommended for building third party integrations with Wafeq)

Authenticating API calls via API Key (Private Key)

To use private key authentication you will need to create an API key from your Wafeq Developer console.

When making an API call to a Wafeq endpoint, you must use an Authorization header with Api-Key prefix followed by your API key.

Example,

curl --location\
--request GET 'https://api.wafeq.com/v1/organization/' \
--header 'Authorization: Api-Key <api_key>' \
...

Authenticating API calls via Access Token (OAuth Flow)

To use oauth flow authentication you will need to create an App from your Wafeq Developer console.

When making an API call to a Wafeq endpoint, you must use an Authorization header with Bearer prefix followed by the access token obtained by the oauth flow.

Example,

curl --location\
--request GET 'https://api.wafeq.com/v1/organization/' \
--header 'Authorization: Bearer <access_token>' \
...

or you can visit oauth2-client-examples repository for demo apps implementing oauth flow with Wafeq.

Previous
Get your API Key