The Secure Web APIs are designed to allow client applications to access Coinelf using the HTTPS(rest) protocol over the internet. The purpose of this document is to provide the urls and the specification of the messages communicated through Web APIs.
Following API files provide the details of the APIs that are available through different access channels.
| File Name | Description |
|---|---|
| getting-started.md | Getting started document before going through api documents |
| wallets.md | Details on wallets operation APIs |
| pending-approvals.md | Details on pending approval APIs |
| webhook-notifications.md | Details on notification webhook APIs |
| enums.md | Details on Enum fields in the system |
| error-codes.md | Details on API error codes |
All messages are in json format.
| Type | Description |
|---|---|
| Integer | Integer numbers |
| Long | Long numbers |
| Boolean | True/False |
| DoubleString | Decimal numbers are returned as strings to preserve full precision across platforms |
| Enum | Enum definition. Passing invalid enum values will result in API_BAD_REQUEST error |
| String | Text |
Unless otherwise specified, all timestamps returned from API are milliseconds since UNIX Epoch.
| Indicator | Description |
|---|---|
| M | Mandatory field |
| (M) | Mandatory field under certain conditions |
| O | Optional field |