The Arcadia Switch REST APIs provide simple RESTful interfaces with lightweight JSON-formatted responses.
This section of the documentation is geared toward developers and covers the basics of using any of our Switch REST API endpoints.
- Authentication - how to authenticate yourself, with examples of various technologies
- REST Request - how to send a request including the domains, paths, and HTTP Method conventions we use. Also includes details on the common parameters for pagination, filtering, and sorting.
- REST Response - we have a standard response wrapped, which is detailed here. We also talk about HTTP status codes and how we return error messages.
- Date Formats - dates and times can be tricky.
- Tools & Helper Libraries - some recommendations for tools that can help with developing and running applications that include our APIs and our Java Client Library, plus other languages, bindings, and helpers.
- Versioning and Releases - how we version APIs and how to request extended fields etc.
- Echo Endpoint - a simple little set of APIs for testing integration.