API Manual
Last updated
Last updated
Cregis offers a comprehensive set of APIs that allow businesses to swiftly integrate digital assets into their platforms, ensuring seamless integration with their operations. Before accessing these features, users must first create a project and generate a unique API key to interact with the platform, providing payment and transfer capabilities.
Click the "API" module to enter the project page. When using the project for the first time, click the "Create" button.
The "Create Project" interface will pop up on the right side. Enter the project name and select the interface type required for the project. Multiple interface types can be opened at the same time. You may check here for API type details. Order Payment Collection request an application to create. If you are interested, please contact us. After enabling the Transfer type, you are suggested to create a policy for API withdrawal. If there is no policy configured, all the withdrawal requests will enter the signature process directly. After enabling the Generate address type, you need to select the wallet. All the sub-address generated will be under this wallet.
Enter the Google 2FA verification code for verification. After successful verification, the project will be created successfully.
To ensure request security, it is necessary to request the IP address of the Cregis API server and add it to the IP allowlist. The Cregis API only grants access to IP addresses in the whitelist.
Select the the project you created and click "API" to enter the API details.
In "IP Whitelist", click "Create Group", enter IP Address and click "Save", then use Google verification code 2FA for identity verification.
To access the Cregis API, you need to use the project API Key, gateway server, and project number information. You can query the corresponding information in the project and give it to the developer.
Select the "API" module and Click "API" to enter the API details. Click the display button of the API key to display the API key information. Click the "Copy" button on the right to copy the API Key, gateway server, and project number information respectively.
Note: Do not easily disclose the project API Key to others, otherwise it may cause asset loss.
Users can apply for the sub-address of the project and bind it to the C-end client of the business platform. Users can give the sub-address to the client for digital asset transactions. Cregis will track the asset situation of the sub-address in real time and provide API to the business platform.
Enter the API module, click the "Address" tab to view the asset balance and transaction records of all sub-addresses.
If a user sets multiple sub-addresses in their project and each address has assets, users with collection permissions can collect all sub-address assets to the specified wallet address, which is convenient for user management and use. The successfully collected funds and gas fees can be queried in the transaction records of the wallet.
Enter the API module and click "Address" - "Collect".
Configure the collection conditions, including the receiver address and interval amount, confirm the number of addresses that meet the conditions, and click "Next".
Enter the transaction password for verification.
After successful verification, Cregis initiates the collection of addresses that meet the conditions and displays the collection progress. If you need to stop the collection, you can click "Stop Collection".
In daily operation, if the business callback fails due to abnormal factors such as changes in the callback address of the business platform and unstable network, and the order status is not updated, it can be viewed and processed in the project callback record.
Click "API" in the Cregis client - > "Callback Record" to display abnormal callback records by default. If the data is empty, it means that there is no abnormal callback data in the current project.
If there is an abnormal callback that causes the order status of the business platform to not be timely updated, click the "Push Order" button.
If the callback fails due to a change in the callback address, please enter the correct callback address and enter the Google 2FA code for verification.
