├── .gitignore ├── CODEOWNERS ├── LICENSE ├── README.md ├── contributing.md ├── doc-gfx ├── app │ ├── api-network.png │ ├── auth-status-200.png │ ├── duplicate-env.png │ ├── edit-auth-type.png │ ├── fork-button.png │ ├── fork-env.png │ ├── limits-status-200.png │ ├── manage-env.png │ ├── manage-token.png │ ├── search-salesforce.png │ ├── select-env.png │ └── soap-login-status-200.png ├── contribution-schema.png ├── salesforce │ ├── cors-finished.png │ └── grant-access.png └── web │ ├── activate-env.png │ ├── allow-open-app.png │ ├── allow-popup.png │ ├── api-network.png │ ├── auth-status-200.png │ ├── change-visibility-public.png │ ├── create-pull-request.png │ ├── duplicate-env.png │ ├── fork.png │ ├── limits-status-200.png │ ├── manage-token.png │ ├── merge-changes.png │ ├── pull-changes.png │ ├── rename-env.png │ ├── settings-disable-headers.png │ └── settings.png ├── install-with-app.md ├── install-with-web.md ├── updating.md └── working-with-environments.md /.gitignore: -------------------------------------------------------------------------------- 1 | # MacOS system files 2 | .DS_Store 3 | 4 | # Windows system files 5 | Thumbs.db 6 | ehthumbs.db 7 | [Dd]esktop.ini 8 | $RECYCLE.BIN/ 9 | 10 | # VS Code project settings 11 | .vscode/ 12 | -------------------------------------------------------------------------------- /CODEOWNERS: -------------------------------------------------------------------------------- 1 | # Comment line immediately above ownership line is reserved for related gus information. Please be careful while editing. 2 | #ECCN:Open Source 3 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | CC0 1.0 Universal 2 | 3 | CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE 4 | LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN 5 | ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS 6 | INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES 7 | REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS 8 | PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM 9 | THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED 10 | HEREUNDER. 11 | 12 | Statement of Purpose 13 | 14 | The laws of most jurisdictions throughout the world automatically confer 15 | exclusive Copyright and Related Rights (defined below) upon the creator 16 | and subsequent owner(s) (each and all, an "owner") of an original work of 17 | authorship and/or a database (each, a "Work"). 18 | 19 | Certain owners wish to permanently relinquish those rights to a Work for 20 | the purpose of contributing to a commons of creative, cultural and 21 | scientific works ("Commons") that the public can reliably and without fear 22 | of later claims of infringement build upon, modify, incorporate in other 23 | works, reuse and redistribute as freely as possible in any form whatsoever 24 | and for any purposes, including without limitation commercial purposes. 25 | These owners may contribute to the Commons to promote the ideal of a free 26 | culture and the further production of creative, cultural and scientific 27 | works, or to gain reputation or greater distribution for their Work in 28 | part through the use and efforts of others. 29 | 30 | For these and/or other purposes and motivations, and without any 31 | expectation of additional consideration or compensation, the person 32 | associating CC0 with a Work (the "Affirmer"), to the extent that he or she 33 | is an owner of Copyright and Related Rights in the Work, voluntarily 34 | elects to apply CC0 to the Work and publicly distribute the Work under its 35 | terms, with knowledge of his or her Copyright and Related Rights in the 36 | Work and the meaning and intended legal effect of CC0 on those rights. 37 | 38 | 1. Copyright and Related Rights. A Work made available under CC0 may be 39 | protected by copyright and related or neighboring rights ("Copyright and 40 | Related Rights"). Copyright and Related Rights include, but are not 41 | limited to, the following: 42 | 43 | i. the right to reproduce, adapt, distribute, perform, display, 44 | communicate, and translate a Work; 45 | ii. moral rights retained by the original author(s) and/or performer(s); 46 | iii. publicity and privacy rights pertaining to a person's image or 47 | likeness depicted in a Work; 48 | iv. rights protecting against unfair competition in regards to a Work, 49 | subject to the limitations in paragraph 4(a), below; 50 | v. rights protecting the extraction, dissemination, use and reuse of data 51 | in a Work; 52 | vi. database rights (such as those arising under Directive 96/9/EC of the 53 | European Parliament and of the Council of 11 March 1996 on the legal 54 | protection of databases, and under any national implementation 55 | thereof, including any amended or successor version of such 56 | directive); and 57 | vii. other similar, equivalent or corresponding rights throughout the 58 | world based on applicable law or treaty, and any national 59 | implementations thereof. 60 | 61 | 2. Waiver. To the greatest extent permitted by, but not in contravention 62 | of, applicable law, Affirmer hereby overtly, fully, permanently, 63 | irrevocably and unconditionally waives, abandons, and surrenders all of 64 | Affirmer's Copyright and Related Rights and associated claims and causes 65 | of action, whether now known or unknown (including existing as well as 66 | future claims and causes of action), in the Work (i) in all territories 67 | worldwide, (ii) for the maximum duration provided by applicable law or 68 | treaty (including future time extensions), (iii) in any current or future 69 | medium and for any number of copies, and (iv) for any purpose whatsoever, 70 | including without limitation commercial, advertising or promotional 71 | purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each 72 | member of the public at large and to the detriment of Affirmer's heirs and 73 | successors, fully intending that such Waiver shall not be subject to 74 | revocation, rescission, cancellation, termination, or any other legal or 75 | equitable action to disrupt the quiet enjoyment of the Work by the public 76 | as contemplated by Affirmer's express Statement of Purpose. 77 | 78 | 3. Public License Fallback. Should any part of the Waiver for any reason 79 | be judged legally invalid or ineffective under applicable law, then the 80 | Waiver shall be preserved to the maximum extent permitted taking into 81 | account Affirmer's express Statement of Purpose. In addition, to the 82 | extent the Waiver is so judged Affirmer hereby grants to each affected 83 | person a royalty-free, non transferable, non sublicensable, non exclusive, 84 | irrevocable and unconditional license to exercise Affirmer's Copyright and 85 | Related Rights in the Work (i) in all territories worldwide, (ii) for the 86 | maximum duration provided by applicable law or treaty (including future 87 | time extensions), (iii) in any current or future medium and for any number 88 | of copies, and (iv) for any purpose whatsoever, including without 89 | limitation commercial, advertising or promotional purposes (the 90 | "License"). The License shall be deemed effective as of the date CC0 was 91 | applied by Affirmer to the Work. Should any part of the License for any 92 | reason be judged legally invalid or ineffective under applicable law, such 93 | partial invalidity or ineffectiveness shall not invalidate the remainder 94 | of the License, and in such case Affirmer hereby affirms that he or she 95 | will not (i) exercise any of his or her remaining Copyright and Related 96 | Rights in the Work or (ii) assert any associated claims and causes of 97 | action with respect to the Work, in either case contrary to Affirmer's 98 | express Statement of Purpose. 99 | 100 | 4. Limitations and Disclaimers. 101 | 102 | a. No trademark or patent rights held by Affirmer are waived, abandoned, 103 | surrendered, licensed or otherwise affected by this document. 104 | b. Affirmer offers the Work as-is and makes no representations or 105 | warranties of any kind concerning the Work, express, implied, 106 | statutory or otherwise, including without limitation warranties of 107 | title, merchantability, fitness for a particular purpose, non 108 | infringement, or the absence of latent or other defects, accuracy, or 109 | the present or absence of errors, whether or not discoverable, all to 110 | the greatest extent permissible under applicable law. 111 | c. Affirmer disclaims responsibility for clearing rights of other persons 112 | that may apply to the Work or any use thereof, including without 113 | limitation any person's Copyright and Related Rights in the Work. 114 | Further, Affirmer disclaims responsibility for obtaining any necessary 115 | consents, permissions or other rights required for any use of the 116 | Work. 117 | d. Affirmer understands and acknowledges that Creative Commons is not a 118 | party to this document and has no duty or obligation with respect to 119 | this CC0 or use of the Work. 120 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Salesforce APIs for Postman 2 | 3 | [![Run in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/12721794-67cb9baa-e0da-4986-957e-88d8734647e2?action=collection%2Ffork&collection-url=entityId%3D12721794-67cb9baa-e0da-4986-957e-88d8734647e2%26entityType%3Dcollection%26workspaceId%3D34382471-0c97-40e5-a206-f947271665c4#?env%5BSalesforce%20APIs%20Template%20Environment%5D=W3sia2V5IjoidXJsIiwidmFsdWUiOiJodHRwczovL3Rlc3Quc2FsZXNmb3JjZS5jb20iLCJlbmFibGVkIjp0cnVlfSx7ImtleSI6InZlcnNpb24iLCJ2YWx1ZSI6IjUzLjAiLCJlbmFibGVkIjp0cnVlfSx7ImtleSI6InVzZXJuYW1lIiwidmFsdWUiOiIiLCJlbmFibGVkIjp0cnVlfSx7ImtleSI6InBhc3N3b3JkIiwidmFsdWUiOiIiLCJlbmFibGVkIjp0cnVlfSx7ImtleSI6InNlY3JldFRva2VuIiwidmFsdWUiOiIiLCJlbmFibGVkIjp0cnVlfSx7ImtleSI6ImNsaWVudElkIiwidmFsdWUiOiIzTVZHOThfUHNnNWNwcHlZQ21rMWdaTkMyNW8wMFNYcGdwb2RsUzI5SVo2cFhpSGt0M3h1UGE1cUlqQlR0RWdkc2lNdUlXVk5fOEYwam53RXRiRGg0IiwiZW5hYmxlZCI6dHJ1ZX0seyJrZXkiOiJjbGllbnRTZWNyZXQiLCJ2YWx1ZSI6IiIsImVuYWJsZWQiOnRydWV9LHsia2V5IjoicmVkaXJlY3RVcmwiLCJ2YWx1ZSI6IiIsImVuYWJsZWQiOnRydWV9LHsia2V5IjoiaW5pdEFjY2Vzc1Rva2VuIiwidmFsdWUiOiIiLCJlbmFibGVkIjp0cnVlfSx7ImtleSI6InNpdGUiLCJ2YWx1ZSI6IiIsImVuYWJsZWQiOnRydWV9XQ==) 4 | 5 | A [Postman](https://www.postman.com) collection that contains 250+ requests and example responses for the following Salesforce Platform APIs:: 6 |
Auth
Bulk (v1 & v2)
Composite
Connect
CPQ
Einstein Prediction Service
Event Platform		GraphQL
Metadata
REST
Subscription Management
Tooling
UI
7 | 8 | ![Postman screenshot](doc-gfx/app/limits-status-200.png) 9 | 10 | Learn more about the Collection: 11 | - 🎥 [Webinar](https://trailhead.salesforce.com/live/videos/a2r3k000001WFhk/exploring-the-salesforce-apis-with-postman/) 12 | - 📖 [Blog post](https://developer.salesforce.com/blogs/2020/03/explore-the-salesforce-apis-with-a-postman-collection.html) 13 | 14 | **⚠️ Disclaimers:** 15 | - This collection is provided as-is. It's not officially supported by Salesforce or covered by SLAs. 16 | - API documentation is not provided with the collection. Please refer to the [official documentation](https://developer.salesforce.com/docs). 17 | 18 | 19 | ## Issues and Questions 20 | 21 | Report issues and ask questions [here](https://github.com/forcedotcom/postman-salesforce-apis/issues). 22 | 23 | 24 | ## Installation 25 | 26 | You can use the **Postman desktop app** or the **Postman web UI** to connect to Salesforce with the Salesforce APIs collection: 27 | 28 | - [Install using the Postman desktop app](install-with-app.md) (recommended) 29 | - [Install using the Postman web UI](install-with-web.md) (longer setup, requires CORS configuration in Salesforce org) 30 | 31 | Regardless of whether you choose the desktop app or the web UI, you can use all of the collection’s requests and your changes are synchronized between the two environments so you can easily switch between them at any time. 32 | 33 | 34 | ## Additional Documentation 35 | 36 | - [Keeping the collection up to date](updating.md) 37 | - [Working with environments to connect to multiple orgs](working-with-environments.md) 38 | - [Contributing](contributing.md) 39 | -------------------------------------------------------------------------------- /contributing.md: -------------------------------------------------------------------------------- 1 | [Back to main page](README.md) 2 | 3 | # Contributing 4 | 5 | - [About](#about) 6 | - [Requirements](#requirements) 7 | - [Contribution Guidelines](#contribution-guidelines) 8 | - [Create a Public Team](#create-a-public-team) 9 | - [Create a Public Workspace](#create-a-public-workspace) 10 | - [Move your Collection to your Public Workplace](#move-your-collection-to-your-public-workplace) 11 | - [Create a Pull Request](#create-a-pull-request) 12 | 13 | 14 | ## About 15 | 16 | We’re adding new API requests to the collection over time, but you’re welcome to help. The ability to receive community contributions is a guiding principle for the Salesforce APIs collection. 17 | 18 | With **Public Workspaces**, you’ll find the same contribution flow that you’re already familiar with in git: forks, pull requests and pulls. 19 | 20 | ![Contribution schema](doc-gfx/contribution-schema.png) 21 | 22 | This is also great news for you even if you do not contribute to the collection because you’ll be able to pull changes from the collection (bug fixes, new APIs...) without having to reimport anything. 23 | 24 | 25 | ## Requirements 26 | 27 | In order to contribute to the collection, you need to: 28 | - create a public team. 29 | - create a Public Workspace. 30 | - move your fork of the collection to your Public Workspace. 31 | 32 | All of this can be done with a Postman free plan. 33 | 34 | >⚠️ Warning: you cannot contribute if you install the collection without forking it (legacy installation option and API Network installation) 35 | 36 | 37 | ## Contribution Guidelines 38 | 39 | Follow these guidelines when contributing to the collection: 40 | 41 | - Stage only what is relevant to what you've done. 42 | - Never include credentials. 43 | - Use the API documented names. 44 | - Add description from the documentation in the Postman descriptions. 45 | - Provide the description from the documentation for each GET parameters. 46 | - API calls should work and be parametrized using environment variables: 47 | - Authentication API endpoints must use `{{url}}{{site}}` as host. 48 | - Other API endpoints must use `{{_endpoint}}` as host. 49 | - Optional: provide examples. 50 | 51 | 52 | ## Create a Public Team 53 | 54 | 1. Using a browser, [sign up/in to Postman](https://identity.getpostman.com/login) 55 | 1. Open the top-right dropdown and click **Manage Team** 56 | 1. Click **Team Settings** 57 | 1. Enable **Make team profile public** 58 | 1. Click **Save Changes** 59 | 60 | 61 | ## Create a Public Workspace 62 | 63 | 1. Open the **Workspaces** menu and click **New Workspace** 64 | 1. Fill in a name for your workspace 65 | 1. Select **Team** as the visibility 66 | 1. Click **Create Workspace** 67 | 1. Under the **Sharing** section, change the Team workspace’s visibility to **Public** 68 | 69 | ![Change workspace visibility to public screenshot](doc-gfx/web/change-visibility-public.png) 70 | 71 | 1. Click **Save Changes** 72 | 73 | 74 | ## Move your Collection to your Public Workplace 75 | 76 | 1. Move your mouse over your “Salesforce APIs” forked collection, click on the “three dots” icon next to it and select **Share collection** from the menu. 77 | 1. Select your newly created public workspace from the list. 78 | 1. Click **Share and Continue**. 79 | 1. Click **Close**. 80 | 81 | Use the **Workspace** menu to navigate to your public workspace and find your collection. 82 | 83 | 84 | ## Create a Pull Request 85 | 86 | Once you're ready to contribute, follow these steps: 87 | 88 | 1. Navigate to the workspace that holds your collection 89 | 1. Click on the “three dots” icon next to the “Salesforce APIs” collection and select **Create Pull Request** from the menu. 90 | 91 | ![Create Pull Request screenshot](doc-gfx/web/create-pull-request.png) 92 | 93 | 1. Open the **Changes** tab and review your changes. Make sure you've met the [contribution guidelines](#contribution-guidelines). 94 | 1. Go back to the **Overview** tab. 95 | 1. Fill in the title and description fields. Leave the reviewers list empty. 96 | 1. Click **Create Pull Request**. 97 | 98 | 99 | [Back to main page](README.md) 100 | -------------------------------------------------------------------------------- /doc-gfx/app/api-network.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/forcedotcom/postman-salesforce-apis/207689927a20b81d45fffeb3abbcf8be87963f52/doc-gfx/app/api-network.png -------------------------------------------------------------------------------- /doc-gfx/app/auth-status-200.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/forcedotcom/postman-salesforce-apis/207689927a20b81d45fffeb3abbcf8be87963f52/doc-gfx/app/auth-status-200.png -------------------------------------------------------------------------------- /doc-gfx/app/duplicate-env.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/forcedotcom/postman-salesforce-apis/207689927a20b81d45fffeb3abbcf8be87963f52/doc-gfx/app/duplicate-env.png -------------------------------------------------------------------------------- /doc-gfx/app/edit-auth-type.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/forcedotcom/postman-salesforce-apis/207689927a20b81d45fffeb3abbcf8be87963f52/doc-gfx/app/edit-auth-type.png -------------------------------------------------------------------------------- /doc-gfx/app/fork-button.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/forcedotcom/postman-salesforce-apis/207689927a20b81d45fffeb3abbcf8be87963f52/doc-gfx/app/fork-button.png -------------------------------------------------------------------------------- /doc-gfx/app/fork-env.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/forcedotcom/postman-salesforce-apis/207689927a20b81d45fffeb3abbcf8be87963f52/doc-gfx/app/fork-env.png -------------------------------------------------------------------------------- /doc-gfx/app/limits-status-200.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/forcedotcom/postman-salesforce-apis/207689927a20b81d45fffeb3abbcf8be87963f52/doc-gfx/app/limits-status-200.png -------------------------------------------------------------------------------- /doc-gfx/app/manage-env.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/forcedotcom/postman-salesforce-apis/207689927a20b81d45fffeb3abbcf8be87963f52/doc-gfx/app/manage-env.png -------------------------------------------------------------------------------- /doc-gfx/app/manage-token.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/forcedotcom/postman-salesforce-apis/207689927a20b81d45fffeb3abbcf8be87963f52/doc-gfx/app/manage-token.png -------------------------------------------------------------------------------- /doc-gfx/app/search-salesforce.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/forcedotcom/postman-salesforce-apis/207689927a20b81d45fffeb3abbcf8be87963f52/doc-gfx/app/search-salesforce.png -------------------------------------------------------------------------------- /doc-gfx/app/select-env.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/forcedotcom/postman-salesforce-apis/207689927a20b81d45fffeb3abbcf8be87963f52/doc-gfx/app/select-env.png -------------------------------------------------------------------------------- /doc-gfx/app/soap-login-status-200.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/forcedotcom/postman-salesforce-apis/207689927a20b81d45fffeb3abbcf8be87963f52/doc-gfx/app/soap-login-status-200.png -------------------------------------------------------------------------------- /doc-gfx/contribution-schema.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/forcedotcom/postman-salesforce-apis/207689927a20b81d45fffeb3abbcf8be87963f52/doc-gfx/contribution-schema.png -------------------------------------------------------------------------------- /doc-gfx/salesforce/cors-finished.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/forcedotcom/postman-salesforce-apis/207689927a20b81d45fffeb3abbcf8be87963f52/doc-gfx/salesforce/cors-finished.png -------------------------------------------------------------------------------- /doc-gfx/salesforce/grant-access.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/forcedotcom/postman-salesforce-apis/207689927a20b81d45fffeb3abbcf8be87963f52/doc-gfx/salesforce/grant-access.png -------------------------------------------------------------------------------- /doc-gfx/web/activate-env.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/forcedotcom/postman-salesforce-apis/207689927a20b81d45fffeb3abbcf8be87963f52/doc-gfx/web/activate-env.png -------------------------------------------------------------------------------- /doc-gfx/web/allow-open-app.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/forcedotcom/postman-salesforce-apis/207689927a20b81d45fffeb3abbcf8be87963f52/doc-gfx/web/allow-open-app.png -------------------------------------------------------------------------------- /doc-gfx/web/allow-popup.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/forcedotcom/postman-salesforce-apis/207689927a20b81d45fffeb3abbcf8be87963f52/doc-gfx/web/allow-popup.png -------------------------------------------------------------------------------- /doc-gfx/web/api-network.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/forcedotcom/postman-salesforce-apis/207689927a20b81d45fffeb3abbcf8be87963f52/doc-gfx/web/api-network.png -------------------------------------------------------------------------------- /doc-gfx/web/auth-status-200.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/forcedotcom/postman-salesforce-apis/207689927a20b81d45fffeb3abbcf8be87963f52/doc-gfx/web/auth-status-200.png -------------------------------------------------------------------------------- /doc-gfx/web/change-visibility-public.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/forcedotcom/postman-salesforce-apis/207689927a20b81d45fffeb3abbcf8be87963f52/doc-gfx/web/change-visibility-public.png -------------------------------------------------------------------------------- /doc-gfx/web/create-pull-request.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/forcedotcom/postman-salesforce-apis/207689927a20b81d45fffeb3abbcf8be87963f52/doc-gfx/web/create-pull-request.png -------------------------------------------------------------------------------- /doc-gfx/web/duplicate-env.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/forcedotcom/postman-salesforce-apis/207689927a20b81d45fffeb3abbcf8be87963f52/doc-gfx/web/duplicate-env.png -------------------------------------------------------------------------------- /doc-gfx/web/fork.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/forcedotcom/postman-salesforce-apis/207689927a20b81d45fffeb3abbcf8be87963f52/doc-gfx/web/fork.png -------------------------------------------------------------------------------- /doc-gfx/web/limits-status-200.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/forcedotcom/postman-salesforce-apis/207689927a20b81d45fffeb3abbcf8be87963f52/doc-gfx/web/limits-status-200.png -------------------------------------------------------------------------------- /doc-gfx/web/manage-token.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/forcedotcom/postman-salesforce-apis/207689927a20b81d45fffeb3abbcf8be87963f52/doc-gfx/web/manage-token.png -------------------------------------------------------------------------------- /doc-gfx/web/merge-changes.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/forcedotcom/postman-salesforce-apis/207689927a20b81d45fffeb3abbcf8be87963f52/doc-gfx/web/merge-changes.png -------------------------------------------------------------------------------- /doc-gfx/web/pull-changes.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/forcedotcom/postman-salesforce-apis/207689927a20b81d45fffeb3abbcf8be87963f52/doc-gfx/web/pull-changes.png -------------------------------------------------------------------------------- /doc-gfx/web/rename-env.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/forcedotcom/postman-salesforce-apis/207689927a20b81d45fffeb3abbcf8be87963f52/doc-gfx/web/rename-env.png -------------------------------------------------------------------------------- /doc-gfx/web/settings-disable-headers.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/forcedotcom/postman-salesforce-apis/207689927a20b81d45fffeb3abbcf8be87963f52/doc-gfx/web/settings-disable-headers.png -------------------------------------------------------------------------------- /doc-gfx/web/settings.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/forcedotcom/postman-salesforce-apis/207689927a20b81d45fffeb3abbcf8be87963f52/doc-gfx/web/settings.png -------------------------------------------------------------------------------- /install-with-app.md: -------------------------------------------------------------------------------- 1 | [Back to main page](README.md) 2 | 3 | > Instructions updated for Postman desktop app v8 4 | 5 | # Installing with the Postman Desktop App 6 | 7 | This is the recommended installation option because it is the fastest to set up and doesn’t require changes on your Salesforce org. 8 | 9 | 🎥 [Video instructions](https://youtu.be/W-IwW6RM4F0) 10 | 11 | - [Install the Postman App](#install-the-postman-app) 12 | - [Fork the Collection](#fork-the-collection) 13 | - [Configure the Collection](#configure-the-collection) 14 | - [Authenticate with Salesforce](#authenticate-with-salesforce) 15 | - [Execute a Request](#execute-a-request) 16 | 17 | 18 | ## Install the Postman App 19 | 20 | Download and install the Postman app from [this link](https://www.postman.com/downloads). 21 | 22 | 23 | ### Fork the Collection 24 | 25 | 1. In the Postman desktop app, click on the top search bar and type **Salesforce**. 26 | 1. Click **Salesforce Developers** under Teams. 27 | 28 | ![Searching for Salesforce screenshot](doc-gfx/app/search-salesforce.png) 29 | 30 | 1. Under **Collections** click the **Salesforce Platform APIs** entry. 31 | 1. Click **Fork** in the top right. 32 | 33 | ![Fork button screenshot](doc-gfx/app/fork-button.png) 34 | 35 | 1. Enter a label for your fork (e.g.: “My fork”). 36 | 1. Select a workspace (the default “My Workspace” workspace is fine). 37 | 1. Click **Fork Collection**. 38 | 39 | 40 | ## Configure the Collection 41 | 42 | 1. Click **Salesforce APIs** 43 | 1. Open the **Variables** tab. 44 | 1. If needed, update the `CURRENT VALUE` of the `url` variable with your org's My Domain login URL in one of these formats: 45 | 46 | - `https://MyDomainName--SandboxName.sandbox.my.salesforce.com` for sandboxes or Scratch orgs. 47 | - `https://MyDomainName.my.salesforce.com` for production, Trailhead Playground and Developer Edition orgs. 48 | 49 | 1. Click **Save**. 50 | 51 | 52 | ## Authenticate with Salesforce 53 | 54 | You'll need to authenticate with Salesforce to access the APIs. Doing so grants you an access token that is valid for a certain duration. 55 | 56 | Repeat this step whenever your access token expires. 57 | 58 | 1. Click **Salesforce APIs** 59 | 1. Open the **Authorization** tab. The authorization type should be set to OAuth 2.0. 60 | 1. Click **Get New Access Token**. This opens a browser tab with the Salesforce login screen. 61 | 1. Log in to your Salesforce org. 62 | 1. Click **Allow** to grant access to "Salesforce APIs Collection for Postman" to your org. 63 | 64 | ![Grant access screenshot](doc-gfx/salesforce/grant-access.png) 65 | 66 | At this point, if your environment is correctly set up, you should see a success message and you should be redirected to the Postman app. 67 | 68 | If the redirection doesn't happen, you may need to authorize popups in your browser. 69 | 70 |
Click here for instructions on how to authorize popups. 71 |

72 | Note: these instructions are for Chrome but the steps should be similar with other browsers. 73 | 74 | 1. Click the popup error in the address bar, choose to allow popups from Postman: 75 | 76 | ![Allow popup screenshot](doc-gfx/web/allow-popup.png) 77 | 78 | 1. Refresh the page and allow the browser to open the Postman app: 79 | 80 | ![Open Postman app screenshot](doc-gfx/web/allow-open-app.png) 81 |

82 |
83 | 84 | 1. Copy the value of the `instance_url` field from the token details view. Make sure not to copy the line break character. 85 | 86 | ![Grant access screenshot](doc-gfx/app/manage-token.png) 87 | 88 | 1. Click **Use Token**. 89 | 1. Open the **Variables** tab. 90 | 1. Update the `CURRENT VALUE` of the `_endpoint` variable with the value that you just copied from the `instance_url` field in the access token details. 91 | 1. Click **Save**. 92 | 93 | 94 | ## Execute a Request 95 | 96 | 1. Expand the collection and select the `REST > Limits` request. 97 | 1. Click `Send`. 98 | 99 | At this point, if your environment is correctly set up, you should see a `200 OK` status. This means that you have successfully authenticated with Salesforce and that you can now use the other collection’s requests. 100 | 101 | ![Authenticate screenshot](doc-gfx/app/limits-status-200.png) 102 | 103 | See [additional documentation](README.md#additional-documentation) for more information on how to keep the collection up to date and work with multiple Salesforce orgs. 104 | 105 | 106 | [Back to main page](README.md) 107 | -------------------------------------------------------------------------------- /install-with-web.md: -------------------------------------------------------------------------------- 1 | [Back to main page](README.md) 2 | 3 | # Installing with the Postman Web UI 4 | 5 | Consider this installation option if you can’t install the Postman desktop app. 6 | 7 | 🎥 [Video instructions](https://youtu.be/lxRNs4LsVdo) 8 | 9 | - [Fork the Collection](#fork-the-collection) 10 | - [Configure the Collection](#configure-the-collection) 11 | - [Enable CORS in Salesforce](#enable-cors-in-salesforce) 12 | - [Authenticate with Salesforce](#authenticate-with-salesforce) 13 | - [Execute a Request](#execute-a-request) 14 | 15 | 16 | ## Fork the Collection 17 | 18 | 1. Click this button: 19 | 20 | [![Run in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/12721794-67cb9baa-e0da-4986-957e-88d8734647e2?action=collection%2Ffork&collection-url=entityId%3D12721794-67cb9baa-e0da-4986-957e-88d8734647e2%26entityType%3Dcollection%26workspaceId%3D34382471-0c97-40e5-a206-f947271665c4#?env%5BSalesforce%20APIs%20Template%20Environment%5D=W3sia2V5IjoidXJsIiwidmFsdWUiOiJodHRwczovL3Rlc3Quc2FsZXNmb3JjZS5jb20iLCJlbmFibGVkIjp0cnVlfSx7ImtleSI6InZlcnNpb24iLCJ2YWx1ZSI6IjUzLjAiLCJlbmFibGVkIjp0cnVlfSx7ImtleSI6InVzZXJuYW1lIiwidmFsdWUiOiIiLCJlbmFibGVkIjp0cnVlfSx7ImtleSI6InBhc3N3b3JkIiwidmFsdWUiOiIiLCJlbmFibGVkIjp0cnVlfSx7ImtleSI6InNlY3JldFRva2VuIiwidmFsdWUiOiIiLCJlbmFibGVkIjp0cnVlfSx7ImtleSI6ImNsaWVudElkIiwidmFsdWUiOiIzTVZHOThfUHNnNWNwcHlZQ21rMWdaTkMyNW8wMFNYcGdwb2RsUzI5SVo2cFhpSGt0M3h1UGE1cUlqQlR0RWdkc2lNdUlXVk5fOEYwam53RXRiRGg0IiwiZW5hYmxlZCI6dHJ1ZX0seyJrZXkiOiJjbGllbnRTZWNyZXQiLCJ2YWx1ZSI6IiIsImVuYWJsZWQiOnRydWV9LHsia2V5IjoicmVkaXJlY3RVcmwiLCJ2YWx1ZSI6IiIsImVuYWJsZWQiOnRydWV9LHsia2V5IjoiaW5pdEFjY2Vzc1Rva2VuIiwidmFsdWUiOiIiLCJlbmFibGVkIjp0cnVlfSx7ImtleSI6InNpdGUiLCJ2YWx1ZSI6IiIsImVuYWJsZWQiOnRydWV9XQ==) 21 | 22 | 1. Click **Fork Collection**. 23 | 1. [Sign up/in to Postman](https://identity.getpostman.com/login). 24 | 1. Enter a label for your fork (e.g.: “My fork”). 25 | 1. Select a workspace (the default “My Workspace” workspace is fine). 26 | 1. Click **Fork Collection**. 27 | 28 | 29 | ## Configure the Collection 30 | 31 | 1. Click **Salesforce APIs** 32 | 1. Open the **Variables** tab. 33 | 1. If needed, update the `CURRENT VALUE` of the `url` variable with your org's My Domain login URL in one of these formats: 34 | 35 | - `https://MyDomainName--SandboxName.sandbox.my.salesforce.com` for sandboxes or Scratch orgs. 36 | - `https://MyDomainName.my.salesforce.com` for production, Trailhead Playground and Developer Edition orgs. 37 | 38 | 1. Click **Save**. 39 | 40 | 41 | ## Enable CORS in Salesforce 42 | 43 | 1. In Salesforce Setup, enter `CORS` in the Quick Find and select **CORS**. 44 | 1. Click **New** under Allowed Origins List 45 | 1. Enter `https://*.postman.com` as the **Origin URL Pattern** 46 | 1. Click **Save** 47 | 1. Repeat the previous steps and add `https://*.postman.co` (note the `.co` domain extension) 48 | 49 | ![CORS configuration screenshot](doc-gfx/salesforce/cors-finished.png) 50 | 51 | 52 | ## Authenticate with Salesforce 53 | 54 | You'll need to authenticate with Salesforce to access the APIs. Doing so grants you an access token that is valid for a certain duration. 55 | 56 | Repeat this step whenever your access token expires. 57 | 58 | 1. Click **Salesforce APIs** 59 | 1. Open the **Authorization** tab. The authorization type should be set to OAuth 2.0. 60 | 1. Click **Get New Access Token**. This opens a browser tab with the Salesforce login screen. 61 | 1. Log in to your Salesforce org. 62 | 1. Click **Allow** to grant access to "Salesforce APIs Collection for Postman" to your org. 63 | 64 | ![Grant access screenshot](doc-gfx/salesforce/grant-access.png) 65 | 66 | At this point, if your environment is correctly set up, you should see a success message and you should be redirected to the Postman web UI. 67 | 68 | 1. Copy the value of the `instance_url` field from the token details view. Make sure not to copy the line break character. 69 | 70 | ![Grant access screenshot](doc-gfx/web/manage-token.png) 71 | 72 | 1. Click **Use Token**. 73 | 1. Open the **Variables** tab. 74 | 1. Update the `CURRENT VALUE` of the `_endpoint` variable with the value that you just copied from the `instance_url` field in the access token details. 75 | 1. Click **Save**. 76 | 77 | 78 | ## Execute a Request 79 | 80 | 1. Expand the collection and select the `REST > Limits` request. 81 | 1. Click `Send`. 82 | 83 | At this point, if your environment is correctly set up, you should see a `200 OK` status. This means that you have successfully authenticated with Salesforce and that you can now use the other collection’s requests. 84 | 85 | ![Authenticate screenshot](doc-gfx/web/limits-status-200.png) 86 | 87 | See [additional documentation](README.md#additional-documentation) for more information on how to keep the collection up to date and work with multiple Salesforce orgs. 88 | 89 | 90 | [Back to main page](README.md) 91 | -------------------------------------------------------------------------------- /updating.md: -------------------------------------------------------------------------------- 1 | [Back to main page](README.md) 2 | 3 | # Updating the collection 4 | 5 | You can keep your copy of the collection up to date to benefit from new API requests and bug fixes by pulling changes from the main collection without having to reimport anything. 6 | 7 | 8 | ## Pull Changes 9 | 10 | 1. Using a browser, [sign up/in to Postman](https://identity.getpostman.com/login). 11 | 1. Navigate to the workspace that holds your collection. 12 | 1. Click on the “three dots” icon next to the “Salesforce APIs” collection and select **Merge Changes** from the menu. 13 | 14 | ![Merge changes screenshot](doc-gfx/web/merge-changes.png) 15 | 16 | 1. If the main collection has changes, you'll see a yellow banner with a **Pull Changes** link. Click the link. 17 | 18 | ![Pull changes screenshot](doc-gfx/web/pull-changes.png) 19 | 20 | 1. Review the changes and click **Pull Changes**. 21 | 22 | 23 | [Back to main page](README.md) 24 | -------------------------------------------------------------------------------- /working-with-environments.md: -------------------------------------------------------------------------------- 1 | [Back to main page](README.md) 2 | 3 | # Working with environments to connect to multiple Salesforce orgs 4 | 5 | You can use Postman environments to work with multiple Salesforce orgs in parallel. 6 | 7 | > ⚠️ Using environments means that you will store Salesforce credentials in clear in Postman. Do this at your own risks. 8 | 9 | 10 | - [Import the Template Environment](#import-the-template-environment) 11 | - [Configure the Environment](#configure-the-environment) 12 | - [Change the Collection Authorization Type](#change-the-collection-authorization-type) 13 | - [Authenticate with Salesforce](#authenticate-with-salesforce) 14 | 15 | 16 | ## Import the Template Environment 17 | 18 | 1. Open the master collection from the Salesforce Developers workspace with [this link](https://www.postman.com/salesforce-developers/workspace/salesforce-developers) or using Postman's search bar. 19 | 1. Fork the **Salesforce APIs Environment Template** environment: 20 | 1. Select the **Environments** tab. 21 | 1. Click **Salesforce APIs Environment Template**. 22 | 1. Click **Fork**. 23 | 24 | ![Export environment screenshot](doc-gfx/app/fork-env.png) 25 | 26 | 1. Enter a label for your fork (e.g.: “My fork”). 27 | 1. Select the workspace that contains your working copy of the collection. 28 | 1. Click **Fork Environment**. 29 | 30 | ## Configure the Environment 31 | 32 | 1. Click on the “three dots” icon on the right and select **Duplicate** from the menu. 33 | 34 | ![Duplicate environment screenshot](doc-gfx/app/duplicate-env.png) 35 | 36 | This creates a `Salesforce Environment Template Copy` template. 37 | 38 | 1. Click **Salesforce APIs Environment Template Copy**. 39 | 1. Rename the environment with something meaningful in relation with your Salesforce org (e.g.: “Playground 1”). 40 | 1. Set values in the CURRENT VALUE column for the following variables: 41 | 42 | | Variable | Current Value | 43 | | --- | --- | 44 | | `url` | Either:
- `https://MyDomainName--SandboxName.sandbox.my.salesforce.com` for sandboxes or Scratch orgs.
- `https://MyDomainName.my.salesforce.com` for production, Trailhead Playground and Developer Edition orgs. | 45 | | `username` | Your username | 46 | | `password` | Your password | 47 | | `secretToken` | Your personal [security token](https://help.salesforce.com/articleView?id=user_security_token.htm) (if required by your org) | 48 | 49 | 1. Click **Save**. 50 | 1. Select your environment from the environment dropdown. 51 | 52 | ![Select environment screenshot](doc-gfx/app/select-env.png) 53 | 54 | 55 | ## Change the Collection Authorization Type 56 | 57 | 1. Navigate to the **Collections** tab and select your collection. 58 | 1. In the **Authorization** tab, select **Bearer Token** as the authorization type. 59 | 60 | ![Change collection authorization screenshot](doc-gfx/app/edit-auth-type.png) 61 | 62 | 1. Enter `{{_accessToken}}` for the Token value. 63 | 1. Click **Save** 64 | 65 | 66 | ## Authenticate with Salesforce 67 | 68 | 1. Open the collection’s **Auth** folder and select the **SOAP Login** request 69 | 1. Click **Send** 70 | 71 | At this point, if your environment is correctly set up, you should see a `200 OK` status. This means that you have successfully authenticated with Salesforce and that you can now use the other collection’s requests. 72 | 73 | ![Authenticate screenshot](doc-gfx/app/soap-login-status-200.png) 74 | 75 | 76 | [Back to main page](README.md) 77 | --------------------------------------------------------------------------------