FAQ

This page answers the most frequently asked questions for our Customers and Partners.

Q1: What is client ID? How can I retrieve the client ID?

Client ID is assigned by WorldFirst to identify the Partner during an API call. Partner needs to submit the client ID in the request header before transmitting the message to WorldFirst.

A Partner can retrieve the client ID from WorldFirst solution architecture team. For more about obtaining credentials, refer to the related chapter in the integration guide.

Q2: Why do I need to add and verify the signature?

To ensure the data integrity and authenticity, WorldFirst requires an API call to be properly signed before transmission. Additionally, a Partner needs to verify the signature after receiving an API call from WorldFirst.

For more technical details and steps to generate a signature, sign an API call with the signature, and verify the signature in an API call, refer to the Sign a request and validate the signature chapter.

What agreement needs to be signed when using the Developer Portal for the first time?

Q3: What agreement needs to be signed when using the Developer Portal for the first time?

When logging into the Developer Portal for the first time, the system will display an API Integration Agreement popup. This agreement requires users to accept WorldFirst's API integration terms. Simply check the confirmation box to continue using the Developer Portal.

If a user refuses to sign the agreement, the system will display a confirmation popup, and the user can click "Cancel" to return to the agreement popup. If the user confirms the refusal again, the system will log out, and the agreement popup will be displayed upon every subsequent login until the user agrees to sign. Users can only access Developer Portal features after accepting the agreement.

Q4: Where does the Developer Portal redirect after login?

The Developer Portal redirects users based on their permission roles. If you only have Developer or Developer Manager permissions, the system will automatically redirect to the Developer Portal homepage. If you have both Admin and Developer permissions, you will not be automatically redirected to the Developer Portal.

Q5: How are account operation permissions allocated between Developers and Developer Managers?

Developer Managers can view and manage every page/feature/component in the Developer Portal; manage sandbox configurations, execute all test cases, submit go-live requests to WorldFirst SA for approval, and manage production configurations (WorldFirst SA is required for actual configuration updates).

Developers can submit requests to delete applications, edit applications, and take applications offline, but going live and production configurations require approval from both the Developer Manager and WorldFirst SA.

Q6: Which operations require approval?

Operations requiring approval include Go Live Approval, Delete Application, Take Offline, Edit Public Key, Add Webhook, Edit Webhook, Delete Webhook. Different operation types require corresponding detailed information to be provided.

Q7: What additional information is required when editing a Public Key or Webhook?

When editing a public key or webhook, you need to provide the old value (such as the old webhook URL, old public key, old events, etc.) and the new value (such as the new webhook URL, new public key, new events, etc.). This is important for reviewing the content of changes.

Q8: What testing tools does the Developer Center provide?

To ensure you have a better integration experience, the WorldFirst Developer Center provides the following testing tools:

• Postman Collection: For quickly calling and verifying API interfaces
• Webhook Simulator: For receiving and debugging external event push notifications
• Mock Rules: For simulating interface returns to support front-end or joint debugging tests

For more information on how to use these testing tools and detailed instructions, please refer to the Testing Tools page in the Developer Center.

Q9: How to submit a go-live request? How to handle a rejected go-live request?

You can only request to go live after completing all necessary test cases. You may optionally fill in an integration reason description and click Submit. After submitting the go-live request and obtaining approval from the Developer Manager, the WorldFirst SA team will review your test cases and provide the audit result within 4-5 business days.

If the go-live request is rejected, you need to review the WorldFirst SA team's comments to understand the reasons for rejection, resolve any outstanding issues based on the feedback, and resubmit the go-live request.

Q10: What configurations can be made in the production environment after going live?

After go-live approval, you can set up and manage production environment keys, as well as add, edit, or delete webhooks and webhook URLs. However, these operations require approval from the Developer Manager.

You will not be able to add, edit, or delete solutions and modules in the production environment. If the scope changes and module configuration needs to be modified, you can create a new application.

Q11: What are the restrictions on deleting an application?

Users can only delete applications with a status of "Sandbox Setup" or "Testing". When the application status is "Go Live Request Submitted" or "Live", deletion is not allowed.

Q12：How can I contact the WF SA team?

If you have any questions, please email the WorldFirst Support Team.