postman

Go client for Postman REST API

Coverage

API

• POST /apis
• GET /apis
• GET /apis/:apiId
• PUT /apis/:apiId
• DELETE /apis/:apiId
• POST /apis/versions
• GET /apis/versions
• GET /apis/:apiId/versions/:versionId
• PUT /apis/:apiId/versions/:versionId
• DELETE /apis/:apiId/versions/:versionId
• POST /apis/versions/releases
• GET /apis/versions/releases
• GET /apis/:apiId/versions/:versionId/releases/:releaseId
• PUT /apis/:apiId/versions/:versionId/releases/:releaseId
• DELETE /apis/:apiId/versions/:versionId/releases/:releaseId
• POST /apis/:apiId/versions/:versionId/schemas
• GET /apis/:apiId/versions/:versionId/schemas/:schemaId
• PUT /apis/:apiId/versions/:versionId/schemas/:schemaId
• POST /apis/:apiId/versions/:versionId/schemas/:schemaId/collections
• POST /apis/:apiId/versions/:versionId/relations
• GET /apis/:apiId/versions/:versionId/relations
• GET /apis/:apiId/versions/:versionId/test
• GET /apis/:apiId/versions/:versionId/testsuite
• GET /apis/:apiId/versions/:versionId/contracttest
• GET /apis/:apiId/versions/:versionId/environment
• GET /apis/:apiId/versions/:versionId/integrationtest
• GET /apis/:apiId/versions/:versionId/documentation
• GET /apis/:apiId/versions/:versionId/monitor
• PUT /apis/:apiId/versions/:versionId/:relationType/:entityId/syncWithSchema

API Security

• POST /security/api-validation

Audit Logs

• GET /audit/logs

Collections

• POST /collections
• GET /collections
• GET /collections/:id
• PUT /collections/:id
• DELETE /collections/:id
• POST /collections/fork/:id
• POST /collections/merge

Environments

• POST /environments
• GET /environments
• GET /environments/:id
• PUT /environments/:id
• DELETE /environments/:id

Mocks

• POST /mocks
• GET /mocks
• GET /mocks/:mockId
• PUT /mocks/:mockId
• DELETE /mocks/:mockId
• POST /mocks/:mockId/server-responses
• GET /mocks/:mockId/server-responses
• GET /mocks/:mockId/server-responses/:serverResponseId
• PUT /mocks/:mockId/server-respones/:serverResponseId
• DELETE /mocks/:mockId/server-responses/:serverResponseId
• POST /mocks/:mockId/publish
• DELETE /mocks/:mockId/unpublish
• GET /mocks/:mockId/call-logs

Monitors

• POST /monitors
• GET /monitors
• GET /monitors/:id
• PUT /monitors/:id
• DELETE /monitors/:id
• POST /monitors/:id/run

Workspaces

• POST /workspaces
• GET /workspaces
• GET /workspaces/:id
• PUT /workspaces/:id
• DELETE /workspaces/:id

User

• GET /me

Import

• POST /import/openapi
• POST /import/exported

Webhooks

• POST /webhooks

SCIM 2.0 - Identity

• GET /scim/v2/ResourceTypes
• GET /scim/v2/ServiceProviderConfig
• POST /scim/v2/Users
• GET /scim/v2/Users
• GET /scim/v2/Users/:id
• PUT /scim/v2/Users/:id
• PATCH /scim/v2/Users/:id
• POST /scim/v2/Groups
• GET /scim/v2/Groups
• GET /scim/v2/Groups/:id
• PATCH /scim/v2/Group/:id

Usage

package main

import (
	"context"
	"fmt"

	"github.com/actatum/postman-client"
	"github.com/actatum/postman-client/webhooks"
)

func main() {
	cs := postman.NewClientSet("api-key")
	webhookClient := cs.Webhooks()
	webhook, err := webhookClient.Create(
		context.Background(),
		webhooks.Webhook{
			Name:       "Test Webhook",
			Collection: "collection-id",
		},
	)
	if err != nil {
		panic(err)
	}

	fmt.Printf("%v\n", webhook)
}

Missing endpoints

It's possible some endpoints may be missing from the client. You can use methods from the rest.Client to call an endpoint. rest.NewClient -> client.NewRequest -> client.DoRequest.

package main

import (
	"context"
	"fmt"
	"net/http"

	"github.com/actatum/postman-client/rest"
)

func main() {
	// Create a new rest client.
	rc := rest.NewClient("api-key")
	body := map[string]map[string]string{
		"workspace": {
			"name":        "Test Workspace",
			"type":        "personal",
			"description": "This is a test personal workspace.",
		},
	}

	// Create http request.
	r, err := rc.NewRequest(
		context.Background(),
		http.MethodPost,
		"https://api.getpostman.com/workspaces",
		body,
	)
	if err != nil {
		panic(err)
	}

	// Do request and unmarshal into response object.
	var response map[string]interface{}
	err = rc.DoRequest(r, &response)
	if err != nil {
		panic(err)
	}

	fmt.Printf("Response: %v\n", response)
}

How to Contribute

• Fork this repository
• Add your change or fix
• Make sure tests pass
• Create a pull request

Current contributors:

• Aaron Tatum

Tests

• Unit tests: go test -v -race -cover -short ./...
• Unit & Integration tests: go test -v -race -cover ./...