Skip to content

openapi/get-started-with-oauth-v2

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Openapi OAuth V2

🚀 OAuth V2 is now live

Granular token limits · Refresh-token rotation · Wallet transactions · Advanced stats · Full monitoring

API Version License Sandbox
Linux Foundation Member

Read the docs →


🔐 OAuth V2 — Get Started

A curated collection of ready-to-run examples for the Openapi OAuth V2 API — pick your language, set your credentials, and go.

What's new in V2?

  • Granular token limits — cap total requests, paid requests, wallet spend and allowed IPs per token
  • Refresh-token rotation — extend a token's TTL securely via PATCH without losing accumulated stats
  • Wallet transactions — paginated history of every credit and expense on your account
  • Advanced stats — aggregate metrics, unique IP lists, and per-domain / per-scope breakdowns
  • Full monitoring — inspect callback deliveries, active subscriptions and integration error logs

Documentation

Resource Link
Getting started guide console.openapi.com/apis/oauthv2
API Reference (Swagger UI) console.openapi.com/apis/oauthv2/documentation
Postman collection openapi.com/en/docs/oauth#postman
OAS3 specification openapi.com/en/docs/oauth#oas3

Examples

Each subfolder contains self-contained, runnable examples for a specific language or tool.

Language / Tool Folder
cURL examples/curl

Authentication

All endpoints use HTTP Basic Auth — your account email as username and your API key as password.

Authorization: Basic base64(EMAIL:APIKEY)

The only exception is token refresh: pass the refresh token as a Bearer token when calling PATCH /tokens/{token}.

Quick start

  1. Generate a token from the Openapi console or via API.
  2. Pick the examples folder for your language.
  3. Copy the snippet, set your credentials, run it.

Contributing

Contributions are always welcome! Whether you want to report bugs, suggest new features, improve documentation, or contribute code, your help is appreciated.

See docs/contributing.md for detailed instructions on how to get started. Please make sure to follow this project's docs/code-of-conduct.md to help maintain a welcoming and collaborative environment.

Authors

Meet the project authors:

Partners

Meet our partners using Openapi or contributing to this SDK:

Our Commitments

We believe in open source and we act on that belief. We became Silver Members of the Linux Foundation because we wanted to formally support the ecosystem we build on every day. Open standards, open collaboration, and open governance are part of how we work and how we think about software.

License

This project is licensed under the MIT License.

The MIT License is a permissive open-source license that allows you to freely use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the software, provided that the original copyright notice and this permission notice are included in all copies or substantial portions of the software.

In short, you are free to use this SDK in your personal, academic, or commercial projects, with minimal restrictions. The project is provided "as-is", without any warranty of any kind, either expressed or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose, and non-infringement.

For more details, see the full license text at the MIT License page.

About

📣 ANNOUNCEMENT: The Openapi® OAuth system just got a major upgrade V2.

Topics

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Contributors