API Explorer Moves to General Availability

Check out all of the new improvements made in API Explorer

Reddit
LinkedIn

Today we’re announcing the general availability of the API Explorer after its beta release in December 2019. Developers can use the API Explorer to test endpoint behaviors for all publicly available v2 APIs. They can do this within the browser without having to implement any code or update environment configurations. Users can visually interact with our APIs to explore data structures and required parameters, and use in-line reference documentation to learn more about objects, fields, and enums. With this tool developers can become familiar with Square’s APIs in the sandbox before moving to production by easily building example requests and toggling between viewing them in the sandbox and in production.

You can interact with the form to see code examples in a variety of popular languages, including:

  • cURL
  • Ruby
  • Java
  • Python
  • C#
  • PHP

API Explorer Interface

Since the beta launch in December, we've introduced several new features to the Explorer to further help developers get up and going with Square APIs quickly, including:

  • A standalone experience that decouples the previous experience from the API Reference so it can be launched from within the Developer Dashboard or Developer documentation.
  • In-line nonce + test card support for creating payments in the sandbox environment.
  • Language-specific request examples in Ruby, Python, C#, PHP, and Java, which are dynamically displayed when editing the request form.
  • In-line selection of access tokens + app names for signed-in users.
  • In-line date/time examples (in RFC 3339 format) across all date/time fields.
  • An image file upload utility for catalog image creation and creating evidence in a dispute challenge.
  • An in-line idempotency key generator.
  • Typeahead/search for all long enum lists (including country + currency fields with suggested values).

Check out the API Explorer and the newly updated documentation page today.