API Documentation: Integration Guide

Welcome to our step-by-step guide designed to assist integrators in constructing a custom URL for submitting search with digitalcoinranker.com. This guide is intended to make the process as straightforward as possible, ensuring that your data submission is both efficient and accurate.

Introduction

A custom URL is used to send client data directly to digitalcoinranker.com. This method streamlines the process of data entry, reducing the risk of manual errors and saving time.

Step 1: Understanding the Base URL

The base URL is the foundation of your custom URL. For submitting client data to digitalcoinranker.com, the base URL is:
https://digitalcoinranker.com/

Step 2: Understanding URL Parameters

URL parameters are snippets of data added to the base URL, formatted as key-value pairs. These pairs are joined by the equals sign (=) and separated from each other by the ampersand (&).

Step 3: Parameters Details

Field NameContent-TypeTypeRequiredShort Instructions
crypto_walletClient’s crypto walletStringYesCombination of alphanumeric uppercase and lowercase characters. No spaces and special characters.
cryptocurrencyCryptocurrencyStringYesAlphabetic characters only. Cryptocurrency codes like BTC, ETH.
crypto_amountAmount of cryptocurrencyNumberYesNumeric values only.
client_affiliateIdClient’s affiliate IDStringNoAlphanumeric uppercase and lowercase characters. No spaces and special characters.
fiat_amountAmount of currencyNumberYesNumeric values only.
currencyCurrencyStringYesCurrency codes. USD for US Dollar, EUR for Euro.
client_billStateClient’s billing stateStringYesNo special characters, symbols and numeric digits. 
client_billCountryClient’s billing countryStringYesNo special characters, symbols and numeric digits.
client_billZipcodeClient’s billing zip codeStringYesNumeric values only, spaces and hyphens are allowed.
client_billCityClient’s billing cityStringYesNo special characters, symbols and numeric digits.
client_billAddress2Client’s billing address 2StringNoAlphanumeric uppercase and lowercase characters. No special symbols.
client_billAddress1Client’s billing address 1StringYesAlphanumeric uppercase and lowercase characters. No special symbols.
client_idNumClient’s ID numberStringYesAlphanumeric characters, spaces and hyphens are allowed.
client_phoneNumClient’s phone numberNumberYesNumeric values only.
client_emailClient’s emailStringYesIncludes @. Spaces, special characters and symbols except for the dot (.) and underscore (_) are not allowed. 
client_fullNameClient’s full nameStringYesNumeric values, special symbols are not allowed. At least two words. 
notification_urlNotification urlStringNoThe URL for notifying your system with the transaction result.
Must include http:// or https://.
trans_refNumTransaction reference numberStringNoA returned field from the request
url_redirectUrl redirectStringNoThe URL to which the buyer’s browser is redirected to after completing the payment
Must include http:// or https://.

Full code snippet:

Full Name:

Instructions: Include the customer’s full name in the fullname parameter. Ensure that the name is URL-encoded. The full name should be at least two words. The minimal length of each word in the name is 1 symbol. The parameter does not include numbers, special characters, or leading/trailing spaces

Email:

Instructions: Include the customer’s email address in the email parameter. Ensure that the email address is correctly formatted, including the “@” symbol and a valid domain. Typical email addresses are between 5 and 50 characters. Spaces, special characters and symbols except for the dot (.) and underscore (_) are not allowed. 

Phone Number:

Instructions: Include the customer’s phone number in the phone parameter. Use only numeric characters. No letters, alphabetical, special characters, spaces or symbols. The typical length of a phone number is between 7 and 15 digits. Phone number must begin with + (country code).

ID Number:

Instructions: Include the customer’s ID number in the IDNumber parameter. Ensure that the ID number follows the required format for the user’s country. ID numbers consist of numeric characters. Check for country-specific length requirements, the number should be without spaces..

Billing Address 1:

Instructions: Include the first line of the billing address in the billingAddress1 parameter. Ensure that the address is URL-encoded. The address can include words and numbers. No special characters.

Billing Address 2:

Instructions: Include the second line of the billing address (if applicable) in the billingAddress2 parameter. Ensure that the address is URL-encoded. The address can include words and numbers. No special characters.

Billing City:

Instructions: Include the city of the billing address in the billingCity parameter. Ensure that the city name is URL-encoded. Ensure that the city name consists of alphabetic characters, does not include numbers or special characters, and follows the standard format for city names. Do not include leading or trailing spaces.

Billing Zipcode:

Instructions: Include the ZIP code of the billing address in the billingZipcode parameter. The input should contain only numbers, no spaces or letters, hyphens are allowed. The ZIP code should comply with the Billing Country format.

Billing Country:

Instructions: Include the country of the billing address in the billingCountry parameter. Ensure that the country name is URL-encoded. The parameter should not include special characters,.symbols or numbers in the country name. Use a dropdown list to ensure that users select their country from a predefined and standardised list.

Billing State:

Instructions: Include the state of the billing address in the billingState parameter. Ensure that the state name is URL-encoded. No special characters, symbols and numeric digits. Use a dropdown list.

Currency:

Instructions: Include the selected currency for the transaction in the currency parameter. Use the currency code (e.g., USD for US Dollar). Use a dropdown list to choose from predefined and standardised options.

Currency Amount:

Instructions: Include the amount of the selected currency for the transaction in the currencyAmount parameter. Use a valid numeric value. Ensure that the input consists of numeric characters only. Specify the appropriate decimal separator based on the currency (e.g., period “.” or comma “,”). Еhe maximum number of decimal places allowed for the currency amount is 2. Set minimum and maximum acceptable amounts for the currency to prevent unrealistically low or high values. Ensure the amount is positive and within the allowable decimal places. Examples: 100, 100.50, 1000.

Cryptocurrency:

Instructions: Include the selected cryptocurrency for the transaction in the cryptocurrency parameter. Use the cryptocurrency code (e.g., BTC for Bitcoin). Select your cryptocurrency from the provided list. Enter the cryptocurrency name using alphabetic characters only, with no special characters or numeric digits. Use the standard, full name or abbreviation of the cryptocurrency (e.g., Bitcoin or BTC).

Cryptocurrency Amount:

Instructions: Include the amount of the selected cryptocurrency for the transaction in the cryptocurrencyAmount parameter. Use a valid numeric value. Use the appropriate decimal separator for your cryptocurrency. Ensure the amount is positive and within the allowable decimal places. Examples: 0.5, 1.0, 10.

Affiliate ID:

Instructions: Include the optional Affiliate ID associated with the transaction in the affiliateID parameter. It can contain letters and digits. No special characters or symbols are allowed. Ensure that the ID meets any specified length requirements. Example: Affiliate123.

Crypto Wallet:

Instructions: Include the crypto wallet address where the purchased cryptocurrency will be sent in the cryptoWallet parameter using a combination of letters and numbers. Ensure that the address meets the specified length requirements and adheres to the character set guidelines. Example: 1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa.