Introduction

WorldFirst provides a powerful integrated development environment and abundant resources to help you achieve smooth integration. This guide introduces how to use the WorldFirst Developer Center to create, test, and publish WorldFirst products.

Prerequisites

Before you start, ensure the following prerequisites are met:

• Developer Center Account: Register a new account by clicking the invitation email sent by your company admin.
• Client-side Public Key: Refer to the Generate Key Pair steps to generate your public key.
• Notification URL: Provide a URL address to receive SPI notifications.
• Enterprise Information: Provide the required company information and contact details.

Integration steps

Step 1: Create an application

Log in to the Developer Center and navigate to the "Application Management" page. Click "Create an application", enter the application name, and select the solutions you want to use.

Note: If you are unsure which solution to choose, please contact WorldFirst Technical Support.

Step 2: Configure sandbox

2.1 Configure public key

After creating the application, click "View Details". Copy your generated public key and paste it into the input field under Key Management.

2.2 (Optional) Add modules and webhooks

This step is optional. To achieve the best API testing experience, we recommend adding the configurations below:

• Module: Once you select a solution, the system will automatically select the corresponding module and API interface. You can also add multiple modules manually according to your integration needs.
• Webhook: Enter the Webhook address and select the appropriate Webhook. After this configuration is completed, you will no longer need to provide the Webhook address when sending requests.

After adding the configuration, click "Next" to submit the settings, completing the sandbox configuration.

Step 3: Complete API test cases

Before applying for Go Live approval, you need to complete all test cases in the sandbox environment. This ensures your application functions properly.

On the "Application Management" page, click "View" to enter the Test Cases page. You will see all test case groups that need to be completed.

Click "Details" to enter the individual test case group page, then click "Execute", select a Mock Rule, and click "Start".

You can also use the WorldFirst Public API provided by WorldFirst to perform API testing on Postman, including sending requests and receiving responses.

For detailed instructions, refer to the WorldFirst Postman Collection Guide.

Note:

• If the system returns a "Test Case Failed" message, it indicates the test did not pass. Please troubleshoot the issue and retry.
• WorldFirst SA team will evaluate your test case results during the Go Live approval stage. To avoid impacting your approval process, make sure all test cases have passed before submitting the Go Live application.

Step 4: Submit Go-Live request

Once all test cases are completed, you can submit your Go-Live request. Fill in the integration reason and click "Submit".

You can check the approval details at any time by navigating to the "Approval" tab. Once approved, please proceed to Step 5 to complete the production environment configuration.

If your Go-Live request is rejected, you need to troubleshoot and retry according to the rejection reasons provided by the SA team. Once all test cases have been successfully done, submit a new Go-Live request.

Step 5: Launch your application

Before going live, you need to generate a new RSA key pair and reconfigure the public key on the "Integration Settings" page.

Note: Before configuring the public key, ensure you have switched to the production environment.

Click "Finish" to complete the configuration in the production environment.