Freelance Workspace

# 📄 Get started here

This template contains a boilerplate for documentation that you can quickly customize and reuse.

## 🔖 How to use this template

- Replace the content given brackets (()) with your API's details.
    
- Tips are formatted in `codespan` - feel free to read and remove them.
    

---

`Start with a brief overview of what your API offers.`

The ((product name)) provides many API products, tools, and resources that enable you to ((add product value here)).

`You can also list the APIs you offer, link to the relevant pages, or do both in this section.`

## **Getting started guide**

`List the steps or points required to start using your APIs. Make sure to cover everything required to reach success with your API as quickly as possible.`

To start using the ((add APIs here)), you need to -

`The points given below are from The Postman API's documentation. You can reference it to write your own getting started guide.`

- You must use a valid API Key to send requests to the API endpoints. You can get your API key from Postman's [integrations dashboard](https://go.postman.co/settings/me/api-keys).
    
- The API has [rate and usage limits](https://learning.postman.com/docs/developer/postman-api/postman-api-rate-limits/).
    
- The API only responds to HTTPS-secured communications. Any requests sent via HTTP return an HTTP 301 redirect to the corresponding HTTPS resources.
    
- The API returns request responses in JSON format. When an API request returns an error, it is sent in the JSON response as an error key.
    

## Authentication

`Add details on the authorization keys/tokens required, steps that cover how to get them, and the relevant error codes.`

The ((product name)) API uses ((add your API's authorization type)) for authentication.

`The details given below are from the Postman API's documentation. You can reference it to write your own authentication section.`

Postman uses API keys for authentication. You can generate a Postman API key in the [API keys](https://postman.postman.co/settings/me/api-keys) section of your Postman account settings.

You must include an API key in each request to the Postman API with the X-Api-Key request header.

### Authentication error response

If an API key is missing, malformed, or invalid, you will receive an HTTP 401 Unauthorized response code.

## Rate and usage limits

`Use this section to cover your APIs' terms of use. Include API limits, constraints, and relevant error codes, so consumers understand the permitted API usage and practices.`

`The example given below is from The Postman API's documentation. Use it as a reference to write your APIs' terms of use.`

API access rate limits apply at a per-API key basis in unit time. The limit is 300 requests per minute. Also, depending on your plan, you may have usage limits. If you exceed either limit, your request will return an HTTP 429 Too Many Requests status code.

Each API response returns the following set of headers to help you identify your use status:

| Header | Description |
| --- | --- |
| `X-RateLimit-Limit` | The maximum number of requests that the consumer is permitted to make per minute. |
| `X-RateLimit-Remaining` | The number of requests remaining in the current rate limit window. |
| `X-RateLimit-Reset` | The time at which the current rate limit window resets in UTC epoch seconds. |

### 503 response

An HTTP `503` response from our servers indicates there is an unexpected spike in API access traffic. The server is usually operational within the next five minutes. If the outage persists or you receive any other form of an HTTP `5XX` error, [contact support](https://support.postman.com/hc/en-us/requests/new/).

### **Need some help?**

`Add links that customers can refer to whenever they need help.`

In case you have questions, go through our tutorials ((link to your video or help documentation here)). Or visit our FAQ page ((link to the relevant page)).

Or you can check out our community forum, there’s a good chance our community has an answer for you. Visit our developer forum ((link to developer forum)) to review topics, ask questions, and learn from others.

`You can also document or add links to libraries, code examples, and other resources needed to make a request.`

Akowe Verify API Documentation

The `/collections` endpoints let you manage your [collections](https://learning.postman.com/docs/sending-requests/intro-to-collections/).

Transactions

Get Week Revenue

Get Month Revenue

Get Transaction History

Get Collection

Organization

Get Balance

Get Organization

Default

Akowe Verify

Development

Production

<h2 class="slate-h2 " >🚀 </h2><p class="slate-p " >Welcome to the <strong class="slate-bold">Akowe API</strong> documentation! Akowe is an innovative <strong class="slate-bold">Academic Records Verification Platform</strong> designed to streamline and secure the verification process for academic institutions and partners. This API allows <strong class="slate-bold">partner organizations</strong> to easily interact with the Akowe platform, enabling them to manage and track their partnership revenue, view transactions, and access detailed reports.
</p><h3 class="slate-h3 " >Key Features</h3><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Authentication</strong>: Secure access to the API using a <strong class="slate-bold">Authorization:  Bearer {{apiKey}}</strong></div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Balance Overview</strong>: Retrieve the current balance of revenue earned.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Transaction History</strong>: View a detailed list of all transactions and earnings.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Revenue Reports</strong>: Generate weekly and monthly revenue reports for your referred institutions.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Partner Management</strong>: Track the institutions you’ve referred and their performance.
</div></li></ul><h3 class="slate-h3 " >Authentication</h3><p class="slate-p " >To ensure secure access, all API endpoints require authentication via a <strong class="slate-bold">Bearer Token</strong>. You will receive your token after registering with Akowe, and it must be included in the Authorization header of each API request.
</p><h3 class="slate-h3 " >Who Should Use This API?</h3><p class="slate-p " >This API is designed for partner organizations who want to:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Track earnings</strong> from the institutions they have referred.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Monitor revenue growth</strong> on a weekly or monthly basis.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">View detailed transaction history</strong> related to verification fees.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Manage institutional relationships</strong> and track performance.
</div></li></ul><h3 class="slate-h3 " >Next Steps</h3><p class="slate-p " >Explore the available API endpoints and learn how to integrate Akowe’s capabilities into your internal systems to maximize the value of your partnership.</p><p class="slate-p " ></p>

 designed to streamline and secure the verification process for academic institutions and partners. This API allows 

 to easily interact with the Akowe platform, enabling them to manage and track their partnership revenue, view transactions, and access detailed reports.


To ensure secure access, all API endpoints require authentication via a 

. You will receive your token after registering with Akowe, and it must be included in the Authorization header of each API request.


This API is designed for partner organizations who want to:

Explore the available API endpoints and learn how to integrate Akowe’s capabilities into your internal systems to maximize the value of your partnership.

<p class="slate-p " >The Transactions section of the Akowe Verify API allows users to access and modify transaction data associated with their collections. With this functionality, users can retrieve detailed information about transactions, update transaction status, and perform various actions related to transaction management within their collections.</p><p class="slate-p " ></p>

The Transactions section of the Akowe Verify API allows users to access and modify transaction data associated with their collections. With this functionality, users can retrieve detailed information about transactions, update transaction status, and perform various actions related to transaction management within their collections.

<p class="slate-p " >The Organization section of the Akowe Verify API allows partners to retrieve detailed information about organizations registered on the platform. Partners can access data such as organization name, address, and contact information.</p><p class="slate-p " ></p>

The Organization section of the Akowe Verify API allows partners to retrieve detailed information about organizations registered on the platform. Partners can access data such as organization name, address, and contact information.

Sections