Link

Version: 1.0.0

Search

Cerkl’s Postman Collection

Postman is a cross-platform application that makes it easy to explore REST APIs like ours. We maintain a Postman Collection of our API endpoints in parity with what is found in our API reference to allow developers to dig in and mess around with our functionality. Interested? Go ahead and click the “Run in Postman” button below to import our Collection into your Postman application.

Authentication in Postman

Because we use OAuth 2.0 you will need to make sure you select “OAuth 2.0” under TYPE and enter your Cerkl API Client ID and Client Secret in the “Authorization” tab after you select any of our requests. Name it anything you like and set the Access Token URL to api.cerkl.com/v3/oauth/Token and hit “Request Token” to authenticate with our servers. If successful you will be provided with an access token and you can start using our API in Postman.

Cerkl API v3 OAuth 2.0 authentication in Postman.
Cerkl API v3 OAuth 2.0 authentication in Postman.

For more details on API authorization in Postman, see this page.

Using the API in Postman

Making requests with Postman is easy. Once you’re authorized with a shiny new OAuth 2.0 access token and have selected a request to try out, hitting “send” will make the request against our servers. GET and DELETE requests generally don’t require any inputs (unless you’d like to control the paging of results). In contrast, POST and PUT requests require a valid request body in order to create/update resources in your Cerkl instance via the API.

Successful <code>GET</code> request on the <code>/subscriber</code> endpoint.
Successful GET request on the /subscriber endpoint.

To learn more about how to construct valid Cerkl API v3 request bodies, check out our requests documentation and our API Reference. You can also grab usable source code for any of our requests directly from Postman using the “code” button in each request tab:

Use this button to see the request written in different languages.
Use this button to see the request written in different languages.

Using this feature you can quickly prototype calls to Cerkl’s API in your codebase using a variety of languages. Need some PHP code instead of cURL? No problem! Postman has that covered.

Use this button to see the request written in different languages.
Use this button to see the request written in different languages.

These generated request code snippets can be very helpful in the initial stages of building out integrations with Cerkl. If you’re looking for a more fully-featured option to add Cerkl API calls into your codebase you should check out our SDKs that we generate from our OpenAPI specification. We support a small number of them, but Swagger’s CodeGen tool makes it easy to generate an API client for many different languages and platforms.