Skip to content

amcamillo/postman-webex

 
 

Repository files navigation

Postman for Webex Messaging and Admin APIs

This repo gathers Postman collections for Webex Messaging and Admin APIs.

  • Webex Messaging API: Messages, Rooms, Teams, People, Webhooks, AttachmentActions... all Webex resources accessible from an access token, with no admin priviledges.
  • Webex Admin API: Organizations, People creation and updates, Roles, Licenses, Events, Devices, Places and xAPI. These admin related features are accessible only with an access token with admin priviledges.
  • Webex Cards: Messages (with Card attachments), AttachmentActions and Card examples.

Looking for other postman collections, check:

If you're new to Postman, you're only a few steps away from getting the full benefits of the collections:

  1. import and configure a collection
  2. generate code for your favorite language
  3. run collections as part of your CI/CD process via the newman command
  4. publish documentation via documenter.

We welcome pull requests for enhancements of existing collections, as well as contributions of collections that proved to be handy for you. When submitting a new collection, please ensure it leverages a {{access_token}} variable to ease environments sharing among collections. Thank you!

Run in Postman

The collection regroups public resources for the Webex Messaging REST API, with direct links to the official API documentation. The collection a simple user account, no need admin priviledges are required.

public resources

Worth mentionning that the collection is scripted so that you can run REST calls in a row for any given resource:

  • as you run REST queries from top to bottom, newly created resource identifiers are automatically retreived and injected into your postman environment as temporary variables,
  • so that the next REST query will look from the postman environment, and execute in the context of the previous query. For example, you'll add a message into the space you just created in the previous step.
  • at the end of each scenario (embedded in individual collection folders), we've added requests to free newly created resources so that you'll end up in the same state as before running the queries in postman.

Enough talk, let's practice:

  • import the all-resources-scripted collection,
  • create or select a postman environment that contains a {{access_token}} variable,
  • now, you're ready to invoke the API: for example, go to the Messages folder, and run the requests from top to bottom.

memberships

Now, what about generating some code for your favorite language ?

Take the Generate Code Guide and have this Node.js code snippet automatically generated for the API Resource "List spaces":

generate code

Note that the collection is also rendered in HTML for quick browsing via Postman Documenter.

Run in Postman

This collection lets you experiment Webex Cards and Buttons.

You'll need to create an environment with the following variables:

  • access_token: a Webex API access token
  • bot_token: the token of a Webex Bot account

Webex Cards

Note that the collection is also rendered in HTML for quick browsing via Postman Documenter.

Run in Postman

The collection illustrates the REST API Administration Resources, with direct link to the Admin API documentation.

Note that the collection is also rendered in HTML for quick browsing via Postman Documenter.

admin-api

The People folder is populated with pre-request and post-request scripts in order to ease the creation of random accounts.

admin-api

About

Postman collections for Webex REST APIs

Resources

License

Stars

Watchers

Forks

Packages

No packages published