Technical Documentation

This is a landing page which you can use to provide a high-level overview of your APIs

Getting Started

You may also want to include a basic introduction around how to work with your APIs, including such topics as:

  • Create Application
  • Authentication
  • Representation Formats
  • Responses and Errors
  • URLs and Naming
  • Plans and Limits

Create Application

Once you should create an application and getting an API key.

  • Go to the Dashboard. In the "Applications" menu, click on the "Add Application" button.
  • Enter the name and description of your application, then select Platform and click "Next Step" button.
  • Then select API(s) which you want to use and click "Save" button.

Authentication

API key authentication requires each request to be signed. You can create and activate new API keys in your API settings.

Your API keys should be assigned to access only accounts and permission scopes that are necessary for your app to function.

API key can be passed as an HTTP custom header named apikey.

 --header "apikey: YOUR_API_KEY"  

* API key should be kept private and should not be shared.


Representation Formats

All responses are returned using JSON.

 Content-Type: application/json  

Responses and Errors

Our REST API uses standard HTTP status codes to indicate success or failure of API calls.

HTTP Code Description

200

The request was processed and returned successfully.

400

Request invalid or type mismatched parameter

401

The request did not have valid authorization credentials.Please check api-key.

403

Private data you are not allowed to access.

404

Your URL is wrong, or the requested resource doesn't exist.

500

Server Error

URLs and Naming

 https://apigate.akbank.com/api  

Plans and Limits

Coming Soon