FAQ

Welcome to the FAQ section of the Partner Services API documentation. Here, we address some of the most common questions and issues that developers encounter when working with the API. If you have a question that is not covered here, please refer to our support resources or contact our support team.

General Questions

Q1: What is the Partner Services API?

  • A1: The Partner Services API is a comprehensive solution designed to facilitate various financial operations, including managing applications, campaigns, document statuses, and more within a financial ecosystem. It supports integration with advanced platforms like Mambu to streamline and automate financial processes.

Q2: What are the main use cases for the Partner Services API?

  • A2: The main use cases include:

    • Creating and managing financial applications

    • Performing financial calculations

    • Tracking application and document statuses

    • Managing campaigns

    • Retrieving dynamic option lists

Q3: How do I get started with the Partner Services API?

  • A3: To get started, follow these steps:

    1. Obtain your API key from the Partner Services platform.

    2. Set up your development environment and include the API key in your requests.

    3. Refer to the API documentation for detailed information on available endpoints and their usage.

Authentication

Q4: How do I authenticate my requests?

  • A4: All requests must include an API key in the Authorization header in the format Bearer YOUR_API_KEY. For more details, refer to the Authentication section of the documentation.

Q5: What should I do if my API key is not working?

  • A5: Ensure that you are using the correct API key and that it is included in the Authorization header. If the issue persists, contact support for assistance.

Endpoints

Q6: What environments are available for the API?

  • A6: The API supports multiple environments:

    • Development: https://dev-api.partner-services.com

    • Test: https://test-api.partner-services.com

    • Acceptance: https://acceptance-api.partner-services.com

    • Production: https://api.partner-services.com

Q7: How do I switch between different environments?

  • A7: You can switch environments by changing the base URL in your API requests. Ensure that you are using the appropriate API key for each environment.

Error Handling

Q8: What do I do if I receive a 401 Unauthorized error?

  • A8: A 401 Unauthorized error indicates an issue with authentication. Ensure that your API key is correct and included in the Authorization header. If the problem continues, verify that your API key has not expired or been revoked.

Q9: How should I handle 404 Not Found errors?

  • A9: A 404 Not Found error means that the requested resource could not be found. Check the endpoint URL and any path parameters to ensure they are correct. If the resource should exist, contact support for further assistance.

Q10: What does a 500 Internal Server Error mean?

  • A10: A 500 Internal Server Error indicates a problem on the server side. This could be due to various issues, and you should try your request again later. If the error persists, report it to the support team with details of your request.

Rate Limiting

Q11: Is there a rate limit for API requests?

  • A11: Yes, the Partner Services API enforces rate limits to ensure fair usage and maintain performance. If you exceed the rate limit, you will receive a 429 Too Many Requests response. Implement retry logic with exponential backoff to handle rate limiting gracefully.

Q12: How can I monitor my API usage?

  • A12: You can monitor your API usage through the Partner Services platform’s dashboard. This provides insights into the number of requests made, rate limit status, and more.

Support

Q13: How do I contact support for issues with the API?

  • A13: For support, you can reach out to the Partner Services support team via the contact information provided on the platform. Additionally, refer to the support section of the documentation for further resources.

Q14: Are there community resources or forums available?

  • A14: Yes, you can join our community forum to discuss and share knowledge with other developers. This is a great place to ask questions, share solutions, and stay updated on API developments.

By referring to this FAQ section, you can quickly find answers to common questions and issues. For more detailed information, please refer to the respective sections of the documentation or contact support.

PreviousError handlingNextChangelog

Last updated