How Aryze Orders API Works ?

Overview

The Aryze Orders API is designed for creating and managing orders to mint stablecoins like eUSD, eEUR, eGBR, and eSGD. It allows users to specify various details such as the chain, amount, wallet for minting, order name, stablecoin type, customer name, and order status.

Order Creation Process

Asset Minting Across Chains

The Aryze Orders API supports minting stablecoins on different blockchains. Users can specify the target chain and the amount of tokens to mint.

Order Details

When creating an order, users must provide:

• Customer Name: The name of yours organization placing the order

• Chain ID: The blockchain where the tokens will be minted.

• Amount: The number of tokens to mint.

• Mint Wallet: The wallet address where the tokens will be minted.

• Order Name: A unique identifier for the order.

• Stablecoin Type: The type of stablecoin to mint (eUSD, eEUR, eGBR, eSGD).

• Order Status: The status of the order, defaulting to "New".

Example Workflow

1. Create Order: A user submits a request to create an order with all the necessary details.

2. Mint Tokens: Based on the order, the system mints the specified amount of tokens on the designated blockchain.

3. Order Status: The order status can be tracked and updated as it progresses through different stages.

Moving Between Chains

For instance, when minting 100 eEUR on Polygon, the system ensures the secure creation of tokens without duplicating assets across blockchains.

Security and Integrity

Ensuring Accuracy

The API guarantees no double representation of assets and maintains the integrity of the total circulating supply.

Minimizing Risk

By not storing large amounts of assets in a single wallet, the system reduces the risk of hacking.

💸The Aryze Stablecoin Minting API is a comprehensive solution designed to facilitate the seamless creation and management of stablecoin orders, including eUSD, eEUR, eGBR, and eSGD.

Discover how to integrate the Aryze Orders API through the following sections:

Below are some examples demonstrating how to make requests to each of the API methods described earlier.

1. Create Order

pip install requests

import requests
import json

url = "https://api.aryze.io/v1/orders"
headers = {"Content-Type": "application/json", "x-api-key": "YOUR_API_KEY"}
data = {
    "customerName": "John Doe",
    "chainId": "1",
    "amount": "1000",
    "mintWallet": "0x1234567890abcdef",
    "customerOrder": "Order123",
    "stableCoin": "eUSD"
}

response = requests.post(url, headers=headers, data=json.dumps(data))
print(response.text)

npm install axios

const axios = require('axios');

const url = "https://api.aryze.io/v1/orders";
const headers = {
  "Content-Type": "application/json",
  "x-api-key": "YOUR_API_KEY"
};
const data = {
  "customerName": "John Doe",
  "chainId": "1",
  "amount": "1000",
  "mintWallet": "0x1234567890abcdef",
  "customerOrder": "Order123",
  "stableCoin": "eUSD"
};

axios.post(url, data, { headers: headers })
  .then(response => {
    console.log(response.data);
  })
  .catch(error => {
    console.error('Error:', error.response.data);
  });

2. Get All Orders

import requests

url = "https://api.aryze.io/v1/orders"
headers = {"x-api-key": "YOUR_API_KEY"}

response = requests.get(url, headers=headers)
print(response.text)

const axios = require('axios');

const url = "https://api.aryze.io/v1/orders";
const headers = {
  "x-api-key": "YOUR_API_KEY"
};

axios.get(url, { headers: headers })
  .then(response => {
    console.log(response.data);
  })
  .catch(error => {
    console.error('Error:', error.response ? error.response.data : error.message);
  });

3. Get Order By ID

import requests

order_id = "unique_order_id"
url = f"https://api.aryze.io/v1/orders/{order_id}"
headers = {"x-api-key": "YOUR_API_KEY"}

response = requests.get(url, headers=headers)
print(response.text)

const axios = require('axios');

const order_id = "unique_order_id";
const url = `https://api.aryze.io/v1/orders/${order_id}`;
const headers = {
  "x-api-key": "YOUR_API_KEY"
};

axios.get(url, { headers: headers })
  .then(response => {
    console.log(response.data);
  })
  .catch(error => {
    console.error('Error:', error.response ? error.response.data : error.message);
  });

4. Update Order

import requests
import json

order_id = "unique_order_id"
url = f"https://api.aryze.io/v1/orders/{order_id}"
headers = {"Content-Type": "application/json", "x-api-key": "YOUR_API_KEY"}
data = {
    "amount": "1500",
    "orderStatus": "Processing"
}

response = requests.put(url, headers=headers, data=json.dumps(data))
print(response.text)

const axios = require('axios');

const order_id = "unique_order_id";
const url = `https://api.aryze.io/v1/orders/${order_id}`;
const headers = {
  "Content-Type": "application/json",
  "x-api-key": "YOUR_API_KEY"
};
const data = {
  "amount": "1500",
  "orderStatus": "Processing"
};

axios.put(url, data, { headers: headers })
  .then(response => {
    console.log(response.data);
  })
  .catch(error => {
    console.error('Error:', error.response ? error.response.data : error.message);
  });

These examples show how to use Python and JavaScript to interact with the Aryze Orders API, including how to send GET and POST requests, include headers, and serialize data to JSON for the request body. Remember to adjust parameters as needed to match your requirements.

Base URL:

To use the Aryze Orders API, you need an API key. Follow these steps to obtain one:

1. Contact Aryze Support: Reach out to the Aryze support team via email or the support contact form on their website.

2. Request API Access: Specify that you need an API key for the Aryze Orders API and provide any necessary details about your intended usage.

3. Approval Process: Wait for the Aryze team to review and approve your request.

4. Receive API Key: Once approved, you will receive your API key via email.

Use the API key in the headers of your requests as shown in the examples below:

Create Order

• URL: /orders

• Method: POST

• Request Headers:

  • Content-Type: application/json

  • x-api-key: <API_KEY>

Creates a new order for minting stablecoins.

• Body Parameters:

  • customerName: The name of the customer.

  • chainId: The chain ID of the target blockchain.

  • amount: The number of tokens to mint.

  • mintWallet: The wallet address for minting.

  • customerOrder: The unique name for the order.

  • stableCoin: The type of stablecoin (eUSD, eEUR, eGBR, eSGD).

• Success Response: 201 Created

  • Content: { "message": "Order created successfully", "orderId": "unique_order_id" }Get All Orders

• Error Response: 400 Bad Request

  • Content: { "error": "error_message" }

Get All Orders

• URL /orders

• Method: GET

• Request Headers:

  • Content-Type: application/json

  • x-api-key: <API_KEY>

Retrieves all orders, with optional filtering by status.

• Query Parameters::

  • filterStatus (optional): The status to filter orders by.

• Success Response: 200 OK

• Error Response: 400 Bad Request

  • Content: { "error": "error_message" }

Get Order By ID

• URL: /orders/{orderId}

• Method: GET

• Request Headers:

  • Content-Type: application/json

  • x-api-key: <API_KEY>

Retrieves the details of a specific order by ID.

• Path Parameters:

  • orderId: The unique ID of the order.

• Success Response: 200 OK

• Error Response: 400 Bad Request

  • Content: { "error": "Order not found" }

Update Order

• URL: /orders/{orderId}

• Method: PUT

• Request Headers:

  • content-Type: application/json

  • x-api-key: <API_KEY>

Updates the details of a specific order.

• Path parameters:

  • orderId: The unique ID of the order.

• Body Parameters:

  • amount: The updated amount of tokens.

  • orderStatus: The updated status of the order.

• Success Response: 200 OK

• Error Response: 400 Bad Request

  • Content: { "error": "error_message" }

Delete Order

• DELETE /orders

• Method: DELETE

• Request Headers:

  • content-Type: application/json

  • x-api-key: <API_KEY>

Deletes a specific order by ID.

• Path Parameters:

  • orderId: The unique ID of the order.

• Success Response: 200 OK

• Error Response: 400 Bad Request

  • Content: { "error": "error_message" }

Types and Interfaces

Order

An interface for order data.

Properties:

• orderId: The unique ID of the order.

• customerName: The name of the customer.

• customerOrder: The unique name for the order.

• stableCoin: The type of stablecoin (eUSD, eEUR, eGBR, eSGD).

• amount: The number of tokens to mint.

• mintWallet: The wallet address for minting.

• orderDate: The timestamp of the order creation.

• orderStatus: The current status of the order.

• lastUpdateTime: The timestamp of the last update