{"id":104946,"date":"2022-02-24T09:00:26","date_gmt":"2022-02-24T17:00:26","guid":{"rendered":"https:\/\/www.backblaze.com\/blog\/?p=104946"},"modified":"2023-07-11T10:03:36","modified_gmt":"2023-07-11T17:03:36","slug":"explore-the-backblaze-s3-compatible-api-with-our-new-postman-collection","status":"publish","type":"post","link":"https:\/\/www.backblaze.com\/blog\/explore-the-backblaze-s3-compatible-api-with-our-new-postman-collection\/","title":{"rendered":"Explore the Backblaze S3 Compatible API With Our New Postman Collection"},"content":{"rendered":"

\"\"<\/p>\n

Postman<\/a> is a platform for building and using APIs. API providers such as Backblaze can use Postman to build API documentation and provide a live environment for developers to experiment with those APIs. Today, you can interact with Backblaze B2 Cloud Storage<\/a> via our new Postman Collection for the Backblaze S3 Compatible API.<\/p>\n

Using the Backblaze S3 Compatible API<\/strong><\/h2>\n

The Backblaze S3 Compatible API implements the most commonly used S3 operations, allowing applications to integrate with Backblaze B2 in exactly<\/em> the same way they do with Amazon S3. Many of our Alliance Partners<\/a> have used the S3 Compatible API in integrating their products and services with Backblaze B2. Often, integration is as simple as allowing the user to specify a custom endpoint, for example, https:\/\/s3.us-west-001.backblazeb2.com<\/code>, alongside their API credentials in the S3 settings, and verifying that the application works as expected with Backblaze B2.<\/p>\n

\n

The Backblaze B2 Native API, introduced alongside Backblaze B2 back in 2015, provides a low-level interface to B2 Cloud Storage. We generally recommend that developers use the S3 Compatible API when writing new applications and integrations, as it is supported by a wider range of SDKs and libraries, and many developers already have experience with Amazon S3. You can use the Backblaze B2 web console or the B2 Native API to access functionality, such as application key management and lifecycle rules, that is not covered by the S3 Compatible API.<\/p>\n

Our post on the B2 Native and S3 Compatible APIs<\/a> provides a more detailed comparison.<\/p>\n<\/div>\n

Most applications and scripts use one of the AWS SDKs<\/a> or the S3 commands in the AWS CLI<\/a> to access Backblaze B2. All of the SDKs, and the CLI, allow you to override the default Amazon S3 endpoint in favor of Backblaze B2. Sometimes, though, you might want to interact directly with Backblaze B2 via the S3 Compatible API, perhaps in debugging an issue, or just to better understand how the service works.<\/p>\n

Exploring the Backblaze S3 Compatible API in Postman<\/strong><\/h2>\n

Our new Backblaze S3 Compatible API Documentation page<\/a> is the definitive reference for developers wishing to access Backblaze B2 directly via the S3 Compatible API.<\/p>\n

\"\"<\/p>\n

In addition to reading the documentation, you can click the Run in Postman<\/strong> button on the top right of the page, log in to the Postman website or desktop app (creating a Postman account is free), and interact with the API.<\/p>\n