# Frequently Asked Questions

# How do I register for an account on the API Developer Portal?

  • To register, visit the API Developer Portal website click on the "Login" button, and then select ‘Not yet registered?’. Fill in the required details, such as your name, email address, and company information. After submitting the registration form, you'll receive an email confirmation to verify your account.

# What is the purpose of creating an application on the API Developer Portal?

  • By creating an application, you can obtain individual API credentials for authentication. These credentials - Client-ID and Client-Secret - enable secure access to the APIs and act as a bridge between your software and the API services, allowing Hapag-Lloyd to verify your identity.

# How do I subscribe to an API product on the Developer Portal?

  • To subscribe to an API product, log in to your Developer Portal account and navigate to the "Applications" section. Click on ‘Create subscription’ select the desired API product and choose the appropriate usage plan or rate limit that suits your needs. Submit your subscription request, and upon approval, you'll gain access to the subscribed API product.

# What is the purpose of subscriptions on the Developer Portal?

  • Subscriptions are "contracts" that link your application with a specific API product. They define the plan and rate limit for your usage of that API product. Subscriptions ensure controlled and scalable access to the APIs based on your specific use case.

# How long does it take for my subscription request to be approved?

  • The time for subscription approval varies and depends on the verification process. Hapag-Lloyd will review your subscription request, and upon successful or negative verification, you'll receive a notification regarding the status of your request.

# How can I access the API documentation on the Developer Portal?

  • Please visit API Documentation (opens new window), where you'll find comprehensive guides, API reference documentation, code samples, and other resources to help you integrate and utilize the APIs effectively.

# Are there any rate limits or usage restrictions for the APIs on the Developer Portal?

  • Yes, API products on the Developer Portal have rate limits or usage restrictions in place. The specific limits are outlined in the documentation and can vary based on the API product or usage plan you have subscribed to. Make sure to review the documentation to understand the limits and any additional requirements. Based on individual preferences, users can choose between three different plans when subscribing to the given product: Tryout, Default, and Premium.

# What should I do if I encounter technical issues or need assistance with the Developer Portal?

  • If you experience technical issues or need assistance, please navigate to the ‘Contact Us’ tab and select the topic of your interest. Additionally, check the "Getting support" section in the documentation as well which includes FAQs, a knowledge base, community forums, or contact details for the support team. Reach out to the provided support channels for help with your specific issue.

# Can I test the APIs on the Developer Portal before integrating them into my software?

  • Yes, the Developer Portal provides a sandbox environment where you can experiment and test the APIs without impacting production systems. The sandbox allows you to familiarize yourself with the APIs, understand their functionality, and validate your integration before going live.

# Is there a cost associated with using the APIs on the Developer Portal?

  • The cost structure for using the APIs on the Developer Portal can vary. Some APIs may be free to use, while others may have usage-based pricing or subscription fees. Review the pricing information provided on the Developer Portal or contact the support team for specific details about the costs associated with the APIs you plan to use.

# Can I use multiple API products within a single application on the Developer Portal?

  • Yes, you can use multiple API products within a single application on the Developer Portal. Ensure that you manage the authentication and usage of each API product correctly within your application.

# Are there any SDKs or client libraries available for the APIs on the Developer Portal?

  • Currently, there are no SDKs or client libraries available, but they may be offered in the future.

# Can I customize the response format of the API data returned by the Developer Portal?

  • The API response format depends on the specifications defined by the API provider. However, many APIs support different response formats such as JSON, XML, or CSV. Refer to the API documentation to understand the supported response formats and any options for customization.

# How can I handle errors and exceptions when using the APIs from the Developer Portal?

  • The API documentation on the Developer Portal provides guidance on error handling and the structure of error responses. It's important to implement proper error-handling logic in your application to handle scenarios like rate limiting, invalid requests, or server errors. The documentation will guide you on how to interpret and handle these errors effectively.

# What level of security is implemented for the APIs on the Developer Portal?

  • API Developer Portal prioritizes security and implements authentication mechanisms, such as OAuth or Bearer tokens. Additionally, encryption protocols (e.g., HTTPS) are provided for secure data transmission. The documentation details the security measures in place for the APIs, ensuring the confidentiality and integrity of the exchanged data.

# Can I create and manage API keys or access tokens for my applications on the Developer Portal?

  • Yes, Developer Portals provide functionality to create and manage API keys or access tokens for your applications. These keys or tokens are unique identifiers used for authentication and authorization purposes. Refer to the documentation for instructions on creating and managing these credentials.

# Is there a testing environment available to simulate API interactions before deploying to production?

  • Yes, the Developer Portal offers a testing or sandbox environment where you can simulate API interactions without affecting the live production environment. This allows you to perform thorough testing, debug any issues, and ensure the stability and correctness of your application before deploying it to production.
Last Updated: 1/18/2024, 9:59:51 AM