Use tools and helper libraries to test Switch API requests, validate credentials, debug payloads, and build integrations.
Use these tools and helper libraries to test Switch API requests, validate credentials, debug payloads, and build integrations.
Use this page after you understand Authentication, Requests, and Responses, or when you need a client tool to inspect requests and responses while building an integration. If you are choosing where to start, see Getting Started.
Tools
Echo APIs
Use Testing & Debugging Overview to test authentication, validate request formatting, and simulate error responses before calling Switch resource APIs.
REST client
Use a REST client to send requests, inspect response payloads, and debug authentication or formatting issues. Arcadia uses Postman internally for testing and debugging.
Postman is especially useful when working with calculator endpoints because you can save request bodies, update parameters, and compare responses while iterating.
Helper libraries
Java client library and examples
Use the actively maintained Java client library if you are building a Java integration. The GitHub repository explains how to get the JAR from a public Maven repository.
You can also review the Java client library getting started guide and Javadoc listing.
Other legacy libraries
The following libraries are not actively maintained by Arcadia or are maintained by third parties. Review them before using them in a production integration.
PHP library and examples
Use the PHP examples on GitHub to get started with Tariff, Price, and Calculate examples. Add your appId and appKey to the PHP page before running the examples.
Ruby library
A third-party client-side Ruby library is available for working with Arcadia APIs. It was developed by Matthew Solt and is available for download. You can also install it with gem install genability.
Next steps
- Use Testing & Debugging Overview or Echo Hello to confirm your client sends authenticated requests correctly.
- Use Simulate Errors to test how your client handles standard error payloads.
- Return to Getting Started to choose the API family that matches your workflow.