Skip to main content

Documentation Index

Fetch the complete documentation index at: https://doc.withedge.co/llms.txt

Use this file to discover all available pages before exploring further.

To enable you access the full Edge api services a test environment has been created for you. In other to proceed with integrating any of the below endpoints, you need to first retrieve your test client and secret keys via your dashboard using the steps below.
  1. Log into your dashboard
  2. Navigate to Settings -> Manage API Credentials
  3. Click on generate secret key and then copy the secret key displayed to in the modal, please note that the secret key is a view once only function
  4. Once you have the secret key, copy your clientId under the test section

​
Base URL

The base URL for all API requests on the production environment is: 
https://api.withedge.co/v1
While the base URL for all API requests on the sandbox environment is: 
https://sandbox.withedge.co/v1

​
Authentication

You are to generate your token using a base64 encoded value of your client and secret keys. Endpoint: GET /auth/token Headers 
Content-Type: application/json
Authorization: Bearer {{Base64 encoded client+secret}}
Sample Response: 
{
	"data": {
		"accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJPcmdhbml6YXRpb25JZCI6ImUwODU5YWYzLWQ1ZjMtNDA5MC05YjY4LWE5OTBmZDcxYjg3MiIsIkFjdG9yIjoiQ2xpZW50IiwiQ2xpZW50SWQiOiIyYzkxNWNkMS0zYzM4LTQ5YjgtYWFlMS05MjFkMjRiM2I3NzYiLCJqdGkiOiJkNjBkZGNjNy1kNDBkLTRhZDUtYTcxYi1mYWUyMmM3OWFmNzgiLCJTY29wZSI6WyJBY2NvdW50LkNyZWF0ZSIsIkN1c3RvbWVyLkNyZWF0ZSIsIktZQi5DcmVhdGUiLCJUcmFuc2FjdGlvbi5DcmVhdGUiXSwiZXhwIjoxNzIxMjE4NTU5LCJpc3MiOiJodHRwczovL3N0ZXJsaW5nZWRnZS1hdXRoLWFwaS1kZXYuc3RlcmxpbmdhcHBzLnAuYXp1cmV3ZWJzaXRlcy5uZXQvIn0.g475CjbgAOUr1E8O_RgM0yNl76P_4kiIAoFiTpEX-AA",
		"tokenType": "Bearer",
		"expiresAt": "3600"
	},
	"message": "Completed successfully",
	"status": "success",
	"statusCode": 200,
	"errors": []
}