Eko Platform Services API
This is a work-in-progress OpenAPI specification for the EPS developer platform. Introduction This API definition is intended to to be a good starting point…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
This is a work-in-progress OpenAPI specification for the EPS developer platform.
Introduction
This API definition is intended to to be a good starting point for
describing your API in
[OpenAPI/Swagger
format](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md).
It also demonstrates features of
create-openapi-repo tool
and
Redoc documentation engine. So beyond
the standard OpenAPI syntax we use a few
[vendor
extensions](https://github.com/Redocly/Redoc/blob/master/docs/redoc-vendor-extensions.md).
OpenAPI Specification
The goal of The OpenAPI Specification is to define a standard, language-agnostic interface to REST APIs which allows both humans and computers to discover and understand the capabilities of the service without access to source code, documentation, or through network traffic inspection. When properly defined via OpenAPI, a consumer can understand and interact with the remote service with a minimal amount of implementation logic. Similar to what interfaces have done for lower-level programming, OpenAPI removes the guesswork in calling the service.
Endpoints 8
Agent Management
- GETGet Services
/user/services?initiator_id=9962981729Return a list of services available for your users 1. This API returns a unique service_code for each service 2. This service_code needs to be used while… - PUTRequest OTP
/user/request/otpSend an OTP to your agent/user to verify their mobile number * Mobile number of the user is an important parameter that needs to be captured during onboarding… - PUTVerify User Mobile Number
/user/verifyVerify your agent/user's mobile number via OTP - PUTOnboard User
/user/onboardOnboard a new agent/user on the platform. We verify the PAN number provided by you in this step and match the name returned in PAN verification and the name… - PUTActivate Service
/user/service/activateActivate a particular service for your agent/user. Mandatory Parameyters for AePS Activation: For the AePS activation, you need to pass user_code,… - GETUser Services Enquiry
/user/services/user_code::user_code?initiator_id=9962981729Returns the status of each service associated with your agent/user.
Customers
- PUTOnboard_PUT
/onboardhttps://api.eko.in:25002/ekoicici/v1/user/onboard - GETGet customer information
/customers/mobile_number::mobile_number?initiator_id=9962981729Get a customer's basic profile information
API details
- Base URL
https://staging.eko.in/ekoapi/v{version}https://api.eko.in/ekoicici/v{version}- Authentication
- None declared in the description
- Operations
- 8 operations on 8 pathsPUT 5GET 3
- Main resources
- Agent Management 6Customers 2
- Description format
- OpenAPI 3.1.0, API version
3.0.0 - Links
- Documentation · OpenAPI document
- Listed from
- Eko's published OpenAPI description (ekoindia/openapi-spec) (MIT)
How to test the Eko Platform Services API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Eko Platform Services API collection, without the publisher's secrets.
- Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
- Send a requestPick an endpoint, for example “Get Services” (GET /user/services?initiator_id=9962981729), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Eko Platform Services API?
This is a work-in-progress OpenAPI specification for the EPS developer platform. Introduction This API definition is intended to to be a good starting point… It is listed under Payments and has 8 endpoints.
Who publishes the Eko Platform Services API?
It is listed from Eko's public API description (an OpenAPI document), not published by Eko on Swastik Codes. Anyone who controls eko.in can claim the profile by adding a DNS TXT record.
What is the base URL of the Eko Platform Services API?
Its description lists 2 base URLs: https://staging.eko.in/ekoapi/v{version}, https://api.eko.in/ekoicici/v{version}. The first is the usual one; the others are typically sandbox or regional servers.
How do I authenticate with the Eko Platform Services API?
Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.
How many endpoints does the Eko Platform Services API have?
8 operations on 8 paths (5 PUT, 3 GET). The largest groups are Agent Management, Customers.
Is forking the Eko Platform Services API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.